| POST | /v1/forms/submissions/search |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FormUID | body | Guid? | No | |
| Mode | body | string | No | |
| Forms | body | List<Guid> | No | |
| Stages | body | List<string> | No | |
| Assignees | body | List<int> | No | |
| Branches | body | List<string> | No | |
| Tags | body | List<string> | No | |
| Search | body | string | No | |
| SortKey | body | string | No | |
| SortDir | body | int | No | |
| Skip | body | int | No | |
| Take | body | int | No | |
| Conds | body | List<FormAnswerCond> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| F | form | string | No | |
| Op | form | string | No | |
| V | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Rows | form | List<FormInboxRow> | No | |
| Matching | form | int | No | |
| ScopeTotal | form | int | No | |
| StageMatching | form | List<FormInboxCount> | No | |
| Counts | form | FormInboxCounts | No | |
| Stages | form | List<FormStageInfo> | No | |
| Capped | form | bool | No | |
| FilterFields | form | List<FormFilterField> | No | |
| TagOptions | form | List<string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | form | Guid | No | |
| FormUID | form | Guid | No | |
| FormName | form | string | No | |
| VersionNo | form | int | No | |
| Number | form | string | No | |
| ApplicantName | form | string | No | |
| Stage | form | string | No | |
| StageLabel | form | string | No | |
| StageTone | form | string | No | |
| AssigneeAgentId | form | int? | No | |
| AssigneeName | form | string | No | |
| BranchName | form | string | No | |
| SubmittedAt | form | DateTime? | No | |
| SubmittedText | form | string | No | |
| Tags | form | List<string> | No | |
| DocsOk | form | int | No | |
| DocsNeed | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| V | form | string | No | |
| L | form | string | No | |
| N | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stages | form | List<FormInboxCount> | No | |
| Assignees | form | List<FormInboxCount> | No | |
| Branches | form | List<FormInboxCount> | No | |
| Tags | form | List<FormInboxCount> | No | |
| Forms | form | List<FormInboxCount> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No | |
| Tone | form | string | No | |
| Kind | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| T | form | string | No | |
| Opts | form | List<FormFilterOpt> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| L | form | string | No |
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
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"}}}