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
import Foundation
import ServiceStack

public class FormSubmissionExportPreviewRequest : Codable
{
    public var query:FormSubmissionSearchRequest
    public var submissionUIDs:[String] = []

    required public init(){}
}

public class FormSubmissionSearchRequest : Codable
{
    public var formUID:String?
    public var mode:String
    public var forms:[String] = []
    public var stages:[String] = []
    public var assignees:[Int] = []
    public var branches:[String] = []
    public var tags:[String] = []
    public var search:String
    public var sortKey:String
    public var sortDir:Int
    public var skip:Int
    public var take:Int
    public var conds:[FormAnswerCond] = []
    public var flags:[String] = []

    required public init(){}
}

public class FormAnswerCond : Codable
{
    public var f:String
    public var op:String
    public var v:String

    required public init(){}
}

public class FormSubmissionExportPreviewResponse : Codable
{
    public var rows:Int
    public var cap:Int
    public var formName:String
    public var canExport:Bool
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift FormSubmissionExportPreviewRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}