Trendsic Platform Service

<back to all web services

FormSubmissionExportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/export/preview

export class FormSubmissionExportPreviewResponse
{
    public Rows: number;
    public Cap: number;
    public FormName: string;
    public CanExport: boolean;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormSubmissionExportPreviewResponse>) { (Object as any).assign(this, init); }
}

export class FormAnswerCond
{
    public F: string;
    public Op: string;
    public V: string;

    public constructor(init?: Partial<FormAnswerCond>) { (Object as any).assign(this, init); }
}

export class FormSubmissionSearchRequest
{
    public FormUID?: string;
    public Mode: string;
    public Forms: string[] = [];
    public Stages: string[] = [];
    public Assignees: number[] = [];
    public Branches: string[] = [];
    public Tags: string[] = [];
    public Search: string;
    public SortKey: string;
    public SortDir: number;
    public Skip: number;
    public Take: number;
    public Conds: FormAnswerCond[] = [];
    public Flags: string[] = [];

    public constructor(init?: Partial<FormSubmissionSearchRequest>) { (Object as any).assign(this, init); }
}

export class FormSubmissionExportPreviewRequest
{
    public Query: FormSubmissionSearchRequest;
    public SubmissionUIDs: string[] = [];

    public constructor(init?: Partial<FormSubmissionExportPreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript FormSubmissionExportPreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/forms/submissions/export/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Query: 
	{
		FormUID: 00000000000000000000000000000000,
		Mode: String,
		Forms: 
		[
			00000000000000000000000000000000
		],
		Stages: 
		[
			String
		],
		Assignees: 
		[
			0
		],
		Branches: 
		[
			String
		],
		Tags: 
		[
			String
		],
		Search: String,
		SortKey: String,
		SortDir: 0,
		Skip: 0,
		Take: 0,
		Conds: 
		[
			{
				F: String,
				Op: String,
				V: String
			}
		],
		Flags: 
		[
			String
		]
	},
	SubmissionUIDs: 
	[
		00000000000000000000000000000000
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 0,
	Cap: 0,
	FormName: String,
	CanExport: False,
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}