| POST | /v1/forms/submissions/{SubmissionUID}/decide/preview |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | path | Guid | No | |
| Outcome | body | string | No | |
| Reason | body | string | No | |
| Note | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Plan | form | FormDecisionPlan | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Who | form | string | No | |
| Stage | form | string | No | |
| Choices | form | List<FormDecisionChoice> | No | |
| Outcome | form | string | No | |
| Reasons | form | List<string> | No | |
| Reason | form | string | No | |
| NeedSig | form | bool | No | |
| SignerName | form | string | No | |
| SignerRefusal | form | string | No | |
| Effects | form | List<FormDecisionEffect> | No | |
| Block | form | string | No | |
| GoLabel | form | string | No | |
| GoCls | form | string | No | |
| CanDecide | form | bool | No | |
| Refusal | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Kind | form | string | No | |
| Text | form | string | No | |
| Tone | 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/preview 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
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Plan:
{
Who: String,
Stage: String,
Choices:
[
{
Id: String,
Label: String
}
],
Outcome: String,
Reasons:
[
String
],
Reason: String,
NeedSig: False,
SignerName: String,
SignerRefusal: String,
Effects:
[
{
Kind: String,
Text: String,
Tone: String
}
],
Block: String,
GoLabel: String,
GoCls: String,
CanDecide: False,
Refusal: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}