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
"use strict";
export class FormSubmissionExportPreviewResponse {
    /** @param {{Rows?:number,Cap?:number,FormName?:string,CanExport?:boolean,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Rows;
    /** @type {number} */
    Cap;
    /** @type {string} */
    FormName;
    /** @type {boolean} */
    CanExport;
    /** @type {string} */
    Message;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormAnswerCond {
    /** @param {{F?:string,Op?:string,V?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    F;
    /** @type {string} */
    Op;
    /** @type {string} */
    V;
}
export class FormSubmissionSearchRequest {
    /** @param {{FormUID?:string,Mode?:string,Forms?:string[],Stages?:string[],Assignees?:number[],Branches?:string[],Tags?:string[],Search?:string,SortKey?:string,SortDir?:number,Skip?:number,Take?:number,Conds?:FormAnswerCond[],Flags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    FormUID;
    /** @type {string} */
    Mode;
    /** @type {string[]} */
    Forms = [];
    /** @type {string[]} */
    Stages = [];
    /** @type {number[]} */
    Assignees = [];
    /** @type {string[]} */
    Branches = [];
    /** @type {string[]} */
    Tags = [];
    /** @type {string} */
    Search;
    /** @type {string} */
    SortKey;
    /** @type {number} */
    SortDir;
    /** @type {number} */
    Skip;
    /** @type {number} */
    Take;
    /** @type {FormAnswerCond[]} */
    Conds = [];
    /** @type {string[]} */
    Flags = [];
}
export class FormSubmissionExportPreviewRequest {
    /** @param {{Query?:FormSubmissionSearchRequest,SubmissionUIDs?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormSubmissionSearchRequest} */
    Query;
    /** @type {string[]} */
    SubmissionUIDs = [];
}

JavaScript FormSubmissionExportPreviewRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}