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.*;

public class dtos
{

    public static class FormSubmissionExportPreviewRequest
    {
        public FormSubmissionSearchRequest Query = null;
        public ArrayList<UUID> SubmissionUIDs = new ArrayList<UUID>();
        
        public FormSubmissionSearchRequest getQuery() { return Query; }
        public FormSubmissionExportPreviewRequest setQuery(FormSubmissionSearchRequest value) { this.Query = value; return this; }
        public ArrayList<UUID> getSubmissionUIDs() { return SubmissionUIDs; }
        public FormSubmissionExportPreviewRequest setSubmissionUIDs(ArrayList<UUID> value) { this.SubmissionUIDs = value; return this; }
    }

    public static class FormSubmissionSearchRequest
    {
        public UUID FormUID = null;
        public String Mode = null;
        public ArrayList<UUID> Forms = new ArrayList<UUID>();
        public ArrayList<String> Stages = new ArrayList<String>();
        public ArrayList<Integer> Assignees = new ArrayList<Integer>();
        public ArrayList<String> Branches = new ArrayList<String>();
        public ArrayList<String> Tags = new ArrayList<String>();
        public String Search = null;
        public String SortKey = null;
        public Integer SortDir = null;
        public Integer Skip = null;
        public Integer Take = null;
        public ArrayList<FormAnswerCond> Conds = new ArrayList<FormAnswerCond>();
        public ArrayList<String> Flags = new ArrayList<String>();
        
        public UUID getFormUID() { return FormUID; }
        public FormSubmissionSearchRequest setFormUID(UUID value) { this.FormUID = value; return this; }
        public String getMode() { return Mode; }
        public FormSubmissionSearchRequest setMode(String value) { this.Mode = value; return this; }
        public ArrayList<UUID> getForms() { return Forms; }
        public FormSubmissionSearchRequest setForms(ArrayList<UUID> value) { this.Forms = value; return this; }
        public ArrayList<String> getStages() { return Stages; }
        public FormSubmissionSearchRequest setStages(ArrayList<String> value) { this.Stages = value; return this; }
        public ArrayList<Integer> getAssignees() { return Assignees; }
        public FormSubmissionSearchRequest setAssignees(ArrayList<Integer> value) { this.Assignees = value; return this; }
        public ArrayList<String> getBranches() { return Branches; }
        public FormSubmissionSearchRequest setBranches(ArrayList<String> value) { this.Branches = value; return this; }
        public ArrayList<String> getTags() { return Tags; }
        public FormSubmissionSearchRequest setTags(ArrayList<String> value) { this.Tags = value; return this; }
        public String getSearch() { return Search; }
        public FormSubmissionSearchRequest setSearch(String value) { this.Search = value; return this; }
        public String getSortKey() { return SortKey; }
        public FormSubmissionSearchRequest setSortKey(String value) { this.SortKey = value; return this; }
        public Integer getSortDir() { return SortDir; }
        public FormSubmissionSearchRequest setSortDir(Integer value) { this.SortDir = value; return this; }
        public Integer getSkip() { return Skip; }
        public FormSubmissionSearchRequest setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public FormSubmissionSearchRequest setTake(Integer value) { this.Take = value; return this; }
        public ArrayList<FormAnswerCond> getConds() { return Conds; }
        public FormSubmissionSearchRequest setConds(ArrayList<FormAnswerCond> value) { this.Conds = value; return this; }
        public ArrayList<String> getFlags() { return Flags; }
        public FormSubmissionSearchRequest setFlags(ArrayList<String> value) { this.Flags = value; return this; }
    }

    public static class FormAnswerCond
    {
        public String F = null;
        public String Op = null;
        public String V = null;
        
        public String getF() { return F; }
        public FormAnswerCond setF(String value) { this.F = value; return this; }
        public String getOp() { return Op; }
        public FormAnswerCond setOp(String value) { this.Op = value; return this; }
        public String getV() { return V; }
        public FormAnswerCond setV(String value) { this.V = value; return this; }
    }

    public static class FormSubmissionExportPreviewResponse
    {
        public Integer Rows = null;
        public Integer Cap = null;
        public String FormName = null;
        public Boolean CanExport = null;
        public String Message = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getRows() { return Rows; }
        public FormSubmissionExportPreviewResponse setRows(Integer value) { this.Rows = value; return this; }
        public Integer getCap() { return Cap; }
        public FormSubmissionExportPreviewResponse setCap(Integer value) { this.Cap = value; return this; }
        public String getFormName() { return FormName; }
        public FormSubmissionExportPreviewResponse setFormName(String value) { this.FormName = value; return this; }
        public Boolean isCanExport() { return CanExport; }
        public FormSubmissionExportPreviewResponse setCanExport(Boolean value) { this.CanExport = value; return this; }
        public String getMessage() { return Message; }
        public FormSubmissionExportPreviewResponse setMessage(String value) { this.Message = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormSubmissionExportPreviewResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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