| POST | /v1/forms/submissions/{SubmissionUID}/decide |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | path | Guid | No | |
| Outcome | body | string | No | |
| Reason | body | string | No | |
| Note | body | string | No | |
| Counter | body | FormCounterSignature | No | |
| From | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Mode | form | string | No | |
| Name | form | string | No | |
| Png | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Sent | form | List<FormFillReceiptLine> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Record | form | FormSubmissionRecord | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | form | Guid | No | |
| FormUID | form | Guid | No | |
| FormName | form | string | No | |
| Noun | form | string | No | |
| Number | form | string | No | |
| ApplicantName | form | string | No | |
| Stage | form | FormStageInfo | No | |
| Tags | form | List<string> | No | |
| AssigneeAgentId | form | int? | No | |
| AssigneeName | form | string | No | |
| BranchName | form | string | No | |
| SubmittedAt | form | DateTime? | No | |
| VersionNo | form | int | No | |
| CurrentVersionNo | form | int | No | |
| form | string | No | ||
| Phone | form | string | No | |
| ContactName | form | string | No | |
| Meta | form | string | No | |
| Stages | form | List<FormStageInfo> | No | |
| Moves | form | List<FormStageInfo> | No | |
| People | form | List<FormPerson> | No | |
| CanEdit | form | bool | No | |
| CanSensitive | form | bool | No | |
| Sections | form | List<FormRecordSection> | No | |
| Docs | form | List<FormRecordDoc> | No | |
| DocCount | form | string | No | |
| Computed | form | List<FormRecordComputed> | No | |
| Timeline | form | List<FormRecordEvent> | No | |
| Notes | form | List<FormRecordEvent> | No | |
| Audit | form | List<FormRecordEvent> | No | |
| IsTest | form | bool | No | |
| VersionText | form | string | No | |
| TenantName | form | string | No | |
| SubmittedIso | form | string | No | |
| OpenRequest | form | FormRecordRequest | No | |
| CanRequest | form | bool | No | |
| RequestTip | form | string | No | |
| Decision | form | FormRecordDecision | No | |
| Earlier | form | List<FormRecordEarlierDecision> | No | |
| CanDecide | form | bool | No | |
| DecideTip | form | string | No | |
| MoveTip | form | string | No | |
| DueAt | form | DateTime? | No | |
| Overdue | form | bool | No | |
| AgeText | form | string | No | |
| DueText | form | string | No | |
| Signatures | form | List<FormRecordSigEntry> | No | |
| Replaced | form | List<FormRecordReplaced> | 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 |
|---|---|---|---|---|
| AgentId | form | int | No | |
| AgentName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Rows | form | List<FormRecordRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| T | form | string | No | |
| Kind | form | string | No | |
| V | form | string | No | |
| Sensitive | form | bool | No | |
| CanReveal | form | bool | No | |
| Locked | form | bool | No | |
| Files | form | List<FormRecordFile> | No | |
| NoFiles | form | bool | No | |
| Sig | form | FormRecordSig | No | |
| Asked | form | bool | No | |
| Changed | form | bool | No | |
| Prev | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | form | Guid | No | |
| Name | form | string | No | |
| Kind | form | string | No | |
| Size | form | string | No | |
| Sensitive | form | bool | No | |
| Locked | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Pending | form | bool | No | |
| Mode | form | string | No | |
| SignerName | form | string | No | |
| Role | form | string | No | |
| RecordId | form | int | No | |
| ImageHash | form | string | No | |
| DocumentDigest | form | string | No | |
| Ip | form | string | No | |
| Browser | form | string | No | |
| ConsentStored | form | bool | No | |
| SignedText | form | string | No | |
| HasImage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Ok | form | bool | No | |
| Tag | form | string | No | |
| Tone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| L | form | string | No | |
| V | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Who | form | string | No | |
| X | form | string | No | |
| T | form | string | No | |
| At | form | DateTime | No | |
| Dot | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestUID | form | Guid | No | |
| Keys | form | List<string> | No | |
| Resign | form | List<string> | No | |
| Note | form | string | No | |
| By | form | string | No | |
| At | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Outcome | form | string | No | |
| Tone | form | string | No | |
| Reason | form | string | No | |
| Note | form | string | No | |
| Text | form | string | No | |
| HasCounter | form | bool | No | |
| Typed | form | bool | No | |
| Drawn | form | bool | No | |
| SigName | form | string | No | |
| SigMeta | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Outcome | form | string | No | |
| Tone | form | string | No | |
| Reason | form | string | No | |
| Note | form | string | No | |
| Text | form | string | No | |
| Counter | form | string | No | |
| Reopened | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordId | form | int | No | |
| Key | form | string | No | |
| Label | form | string | No | |
| Role | form | string | No | |
| SignerName | form | string | No | |
| Mode | form | string | No | |
| HasImage | form | bool | No | |
| ConsentStored | form | bool | No | |
| Replaced | form | bool | No | |
| Counter | form | bool | No | |
| Reopened | form | bool | No | |
| Meta | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestUID | form | Guid | No | |
| AskedBy | form | string | No | |
| AskedAt | form | string | No | |
| AnsweredAt | form | string | No | |
| Covering | form | string | No | |
| Rows | form | List<FormRecordReplacedRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| Kind | form | string | No | |
| V | form | string | No | |
| Sensitive | form | bool | No | |
| CanReveal | form | bool | No | |
| Locked | form | bool | No | |
| Files | form | List<FormRecordFile> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Channel | form | string | No | |
| To | form | string | No | |
| Outcome | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/forms/submissions/{SubmissionUID}/decide HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SubmissionUID: 00000000000000000000000000000000,
Outcome: String,
Reason: String,
Note: String,
Counter:
{
Mode: String,
Name: String,
Png: String
},
From: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Sent:
[
{
Channel: String,
To: String,
Outcome: String
}
],
Record:
{
SubmissionUID: 00000000000000000000000000000000,
FormUID: 00000000000000000000000000000000,
FormName: String,
Noun: String,
Number: String,
ApplicantName: String,
Stage:
{
Id: String,
Label: String,
Tone: String,
Kind: String
},
Tags:
[
String
],
AssigneeAgentId: 0,
AssigneeName: String,
BranchName: String,
SubmittedAt: 0001-01-01,
VersionNo: 0,
CurrentVersionNo: 0,
Email: String,
Phone: String,
ContactName: String,
Meta: String,
Stages:
[
{
Id: String,
Label: String,
Tone: String,
Kind: String
}
],
Moves:
[
{
Id: String,
Label: String,
Tone: String,
Kind: String
}
],
People:
[
{
AgentId: 0,
AgentName: String
}
],
CanEdit: False,
CanSensitive: False,
Sections:
[
{
Title: String,
Rows:
[
{
K: String,
L: String,
T: String,
Kind: String,
V: String,
Sensitive: False,
CanReveal: False,
Locked: False,
Files:
[
{
AttachmentId: 00000000000000000000000000000000,
Name: String,
Kind: String,
Size: String,
Sensitive: False,
Locked: False
}
],
NoFiles: False,
Sig:
{
Pending: False,
Mode: String,
SignerName: String,
Role: String,
RecordId: 0,
ImageHash: String,
DocumentDigest: String,
Ip: String,
Browser: String,
ConsentStored: False,
SignedText: String,
HasImage: False
},
Asked: False,
Changed: False,
Prev: String
}
]
}
],
Docs:
[
{
Name: String,
Ok: False,
Tag: String,
Tone: String
}
],
DocCount: String,
Computed:
[
{
L: String,
V: String
}
],
Timeline:
[
{
Who: String,
X: String,
T: String,
At: 0001-01-01,
Dot: String
}
],
Notes:
[
{
Who: String,
X: String,
T: String,
At: 0001-01-01,
Dot: String
}
],
Audit:
[
{
Who: String,
X: String,
T: String,
At: 0001-01-01,
Dot: String
}
],
IsTest: False,
VersionText: String,
TenantName: String,
SubmittedIso: String,
OpenRequest:
{
RequestUID: 00000000000000000000000000000000,
Keys:
[
String
],
Resign:
[
String
],
Note: String,
By: String,
At: String
},
CanRequest: False,
RequestTip: String,
Decision:
{
Outcome: String,
Tone: String,
Reason: String,
Note: String,
Text: String,
HasCounter: False,
Typed: False,
Drawn: False,
SigName: String,
SigMeta: String
},
Earlier:
[
{
Outcome: String,
Tone: String,
Reason: String,
Note: String,
Text: String,
Counter: String,
Reopened: String
}
],
CanDecide: False,
DecideTip: String,
MoveTip: String,
DueAt: 0001-01-01,
Overdue: False,
AgeText: String,
DueText: String,
Signatures:
[
{
RecordId: 0,
Key: String,
Label: String,
Role: String,
SignerName: String,
Mode: String,
HasImage: False,
ConsentStored: False,
Replaced: False,
Counter: False,
Reopened: False,
Meta: String
}
],
Replaced:
[
{
RequestUID: 00000000000000000000000000000000,
AskedBy: String,
AskedAt: String,
AnsweredAt: String,
Covering: String,
Rows:
[
{
K: String,
L: String,
Kind: String,
V: String,
Sensitive: False,
CanReveal: False,
Locked: False,
Files:
[
{
AttachmentId: 00000000000000000000000000000000,
Name: String,
Kind: String,
Size: String,
Sensitive: False,
Locked: False
}
]
}
]
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}