| POST | /v1/forms/submissions/{SubmissionUID}/notes |
|---|
"use strict";
export class FormStageInfo {
/** @param {{Id?:string,Label?:string,Tone?:string,Kind?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Label;
/** @type {string} */
Tone;
/** @type {string} */
Kind;
}
export class FormPerson {
/** @param {{AgentId?:number,AgentName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentId;
/** @type {string} */
AgentName;
}
export class FormRecordFile {
/** @param {{AttachmentId?:string,Name?:string,Kind?:string,Size?:string,Sensitive?:boolean,Locked?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AttachmentId;
/** @type {string} */
Name;
/** @type {string} */
Kind;
/** @type {string} */
Size;
/** @type {boolean} */
Sensitive;
/** @type {boolean} */
Locked;
}
export class FormRecordSig {
/** @param {{Pending?:boolean,Mode?:string,SignerName?:string,Role?:string,RecordId?:number,ImageHash?:string,DocumentDigest?:string,Ip?:string,Browser?:string,ConsentStored?:boolean,SignedText?:string,HasImage?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Pending;
/** @type {string} */
Mode;
/** @type {string} */
SignerName;
/** @type {string} */
Role;
/** @type {number} */
RecordId;
/** @type {string} */
ImageHash;
/** @type {string} */
DocumentDigest;
/** @type {string} */
Ip;
/** @type {string} */
Browser;
/** @type {boolean} */
ConsentStored;
/** @type {string} */
SignedText;
/** @type {boolean} */
HasImage;
}
export class FormRecordRow {
/** @param {{K?:string,L?:string,T?:string,Kind?:string,V?:string,Sensitive?:boolean,CanReveal?:boolean,Locked?:boolean,Files?:FormRecordFile[],NoFiles?:boolean,Sig?:FormRecordSig}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
K;
/** @type {string} */
L;
/** @type {string} */
T;
/** @type {string} */
Kind;
/** @type {string} */
V;
/** @type {boolean} */
Sensitive;
/** @type {boolean} */
CanReveal;
/** @type {boolean} */
Locked;
/** @type {FormRecordFile[]} */
Files = [];
/** @type {boolean} */
NoFiles;
/** @type {FormRecordSig} */
Sig;
}
export class FormRecordSection {
/** @param {{Title?:string,Rows?:FormRecordRow[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Title;
/** @type {FormRecordRow[]} */
Rows = [];
}
export class FormRecordDoc {
/** @param {{Name?:string,Ok?:boolean,Tag?:string,Tone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {boolean} */
Ok;
/** @type {string} */
Tag;
/** @type {string} */
Tone;
}
export class FormRecordComputed {
/** @param {{L?:string,V?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
L;
/** @type {string} */
V;
}
export class FormRecordEvent {
/** @param {{Who?:string,X?:string,T?:string,At?:string,Dot?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Who;
/** @type {string} */
X;
/** @type {string} */
T;
/** @type {string} */
At;
/** @type {string} */
Dot;
}
export class FormSubmissionRecord {
/** @param {{SubmissionUID?:string,FormUID?:string,FormName?:string,Noun?:string,Number?:string,ApplicantName?:string,Stage?:FormStageInfo,Tags?:string[],AssigneeAgentId?:number,AssigneeName?:string,BranchName?:string,SubmittedAt?:string,VersionNo?:number,CurrentVersionNo?:number,Email?:string,Phone?:string,ContactName?:string,Meta?:string,Stages?:FormStageInfo[],Moves?:FormStageInfo[],People?:FormPerson[],CanEdit?:boolean,CanSensitive?:boolean,Sections?:FormRecordSection[],Docs?:FormRecordDoc[],DocCount?:string,Computed?:FormRecordComputed[],Timeline?:FormRecordEvent[],Notes?:FormRecordEvent[],Audit?:FormRecordEvent[],IsTest?:boolean,VersionText?:string,TenantName?:string,SubmittedIso?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {string} */
FormUID;
/** @type {string} */
FormName;
/** @type {string} */
Noun;
/** @type {string} */
Number;
/** @type {string} */
ApplicantName;
/** @type {FormStageInfo} */
Stage;
/** @type {string[]} */
Tags = [];
/** @type {?number} */
AssigneeAgentId;
/** @type {string} */
AssigneeName;
/** @type {string} */
BranchName;
/** @type {?string} */
SubmittedAt;
/** @type {number} */
VersionNo;
/** @type {number} */
CurrentVersionNo;
/** @type {string} */
Email;
/** @type {string} */
Phone;
/** @type {string} */
ContactName;
/** @type {string} */
Meta;
/** @type {FormStageInfo[]} */
Stages = [];
/** @type {FormStageInfo[]} */
Moves = [];
/** @type {FormPerson[]} */
People = [];
/** @type {boolean} */
CanEdit;
/** @type {boolean} */
CanSensitive;
/** @type {FormRecordSection[]} */
Sections = [];
/** @type {FormRecordDoc[]} */
Docs = [];
/** @type {string} */
DocCount;
/** @type {FormRecordComputed[]} */
Computed = [];
/** @type {FormRecordEvent[]} */
Timeline = [];
/** @type {FormRecordEvent[]} */
Notes = [];
/** @type {FormRecordEvent[]} */
Audit = [];
/** @type {boolean} */
IsTest;
/** @type {string} */
VersionText;
/** @type {string} */
TenantName;
/** @type {string} */
SubmittedIso;
}
export class FormSubmissionRecordResponse {
/** @param {{Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormSubmissionRecord} */
Record;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormSubmissionNoteRequest {
/** @param {{SubmissionUID?:string,Text?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SubmissionUID;
/** @type {string} */
Text;
}
JavaScript FormSubmissionNoteRequest 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}/notes HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SubmissionUID: 00000000000000000000000000000000,
Text: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
]
}
],
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
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}