Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search
FormSubmissionSearchRequest Parameters:
NameParameterData TypeRequiredDescription
FormUIDbodyGuid?No
ModebodystringNo
FormsbodyList<Guid>No
StagesbodyList<string>No
AssigneesbodyList<int>No
BranchesbodyList<string>No
TagsbodyList<string>No
SearchbodystringNo
SortKeybodystringNo
SortDirbodyintNo
SkipbodyintNo
TakebodyintNo
CondsbodyList<FormAnswerCond>No
FormAnswerCond Parameters:
NameParameterData TypeRequiredDescription
FformstringNo
OpformstringNo
VformstringNo
FormSubmissionSearchResponse Parameters:
NameParameterData TypeRequiredDescription
RowsformList<FormInboxRow>No
MatchingformintNo
ScopeTotalformintNo
StageMatchingformList<FormInboxCount>No
CountsformFormInboxCountsNo
StagesformList<FormStageInfo>No
CappedformboolNo
FilterFieldsformList<FormFilterField>No
TagOptionsformList<string>No
ResponseStatusformResponseStatusNo
FormInboxRow Parameters:
NameParameterData TypeRequiredDescription
SubmissionUIDformGuidNo
FormUIDformGuidNo
FormNameformstringNo
VersionNoformintNo
NumberformstringNo
ApplicantNameformstringNo
StageformstringNo
StageLabelformstringNo
StageToneformstringNo
AssigneeAgentIdformint?No
AssigneeNameformstringNo
BranchNameformstringNo
SubmittedAtformDateTime?No
SubmittedTextformstringNo
TagsformList<string>No
DocsOkformintNo
DocsNeedformintNo
FormInboxCount Parameters:
NameParameterData TypeRequiredDescription
VformstringNo
LformstringNo
NformintNo
FormInboxCounts Parameters:
NameParameterData TypeRequiredDescription
StagesformList<FormInboxCount>No
AssigneesformList<FormInboxCount>No
BranchesformList<FormInboxCount>No
TagsformList<FormInboxCount>No
FormsformList<FormInboxCount>No
FormStageInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
ToneformstringNo
KindformstringNo
FormFilterField Parameters:
NameParameterData TypeRequiredDescription
KformstringNo
LformstringNo
TformstringNo
OptsformList<FormFilterOpt>No
FormFilterOpt Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LformstringNo

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/search HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Rows":[{"SubmissionUID":"00000000000000000000000000000000","FormUID":"00000000000000000000000000000000","FormName":"String","VersionNo":0,"Number":"String","ApplicantName":"String","Stage":"String","StageLabel":"String","StageTone":"String","AssigneeAgentId":0,"AssigneeName":"String","BranchName":"String","SubmittedAt":"0001-01-01T00:00:00.0000000","SubmittedText":"String","Tags":["String"],"DocsOk":0,"DocsNeed":0}],"Matching":0,"ScopeTotal":0,"StageMatching":[{"V":"String","L":"String","N":0}],"Counts":{"Stages":[{"V":"String","L":"String","N":0}],"Assignees":[{"V":"String","L":"String","N":0}],"Branches":[{"V":"String","L":"String","N":0}],"Tags":[{"V":"String","L":"String","N":0}],"Forms":[{"V":"String","L":"String","N":0}]},"Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Capped":false,"FilterFields":[{"K":"String","L":"String","T":"String","Opts":[{"Id":"String","L":"String"}]}],"TagOptions":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}