| POST | /v1/forms/submissions/{SubmissionUID}/decide/preview |
|---|
export class FormDecisionChoice
{
public Id: string;
public Label: string;
public constructor(init?: Partial<FormDecisionChoice>) { (Object as any).assign(this, init); }
}
export class FormDecisionEffect
{
public Kind: string;
public Text: string;
public Tone: string;
public constructor(init?: Partial<FormDecisionEffect>) { (Object as any).assign(this, init); }
}
export class FormDecisionPlan
{
public Who: string;
public Stage: string;
public Choices: FormDecisionChoice[] = [];
public Outcome: string;
public Reasons: string[] = [];
public Reason: string;
public NeedSig: boolean;
public SignerName: string;
public SignerRefusal: string;
public Effects: FormDecisionEffect[] = [];
public Block: string;
public GoLabel: string;
public GoCls: string;
public CanDecide: boolean;
public Refusal: string;
public constructor(init?: Partial<FormDecisionPlan>) { (Object as any).assign(this, init); }
}
export class FormSubmissionDecidePreviewResponse
{
public Plan: FormDecisionPlan;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<FormSubmissionDecidePreviewResponse>) { (Object as any).assign(this, init); }
}
export class FormSubmissionDecidePreviewRequest
{
public SubmissionUID: string;
public Outcome: string;
public Reason: string;
public Note: string;
public constructor(init?: Partial<FormSubmissionDecidePreviewRequest>) { (Object as any).assign(this, init); }
}
TypeScript FormSubmissionDecidePreviewRequest DTOs
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
}
}
}