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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormSubmissionExportPreviewRequest
{
    open var Query:FormSubmissionSearchRequest? = null
    open var SubmissionUIDs:ArrayList<UUID> = ArrayList<UUID>()
}

open class FormSubmissionSearchRequest
{
    open var FormUID:UUID? = null
    open var Mode:String? = null
    open var Forms:ArrayList<UUID> = ArrayList<UUID>()
    open var Stages:ArrayList<String> = ArrayList<String>()
    open var Assignees:ArrayList<Int> = ArrayList<Int>()
    open var Branches:ArrayList<String> = ArrayList<String>()
    open var Tags:ArrayList<String> = ArrayList<String>()
    open var Search:String? = null
    open var SortKey:String? = null
    open var SortDir:Int? = null
    open var Skip:Int? = null
    open var Take:Int? = null
    open var Conds:ArrayList<FormAnswerCond> = ArrayList<FormAnswerCond>()
    open var Flags:ArrayList<String> = ArrayList<String>()
}

open class FormAnswerCond
{
    open var F:String? = null
    open var Op:String? = null
    open var V:String? = null
}

open class FormSubmissionExportPreviewResponse
{
    open var Rows:Int? = null
    open var Cap:Int? = null
    open var FormName:String? = null
    open var CanExport:Boolean? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}