| POST | /v1/forms/{FormUID}/restore |
|---|
"use strict";
export class FormStats {
/** @param {{Total?:number,NeedDecision?:number,Waiting?:number,Overdue?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Total;
/** @type {number} */
NeedDecision;
/** @type {number} */
Waiting;
/** @type {number} */
Overdue;
}
export class FormCard {
/** @param {{FormUID?:string,Name?:string,Slug?:string,Noun?:string,NumberPrefix?:string,Description?:string,Tone?:string,Status?:string,PublishedVersionNo?:number,PublishedAt?:string,PublishedBy?:string,DraftDirty?:boolean,DraftUpdatedAt?:string,DraftUpdatedBy?:string,PackLabel?:string,SettingsJson?:string,Stats?:FormStats,Offered?:string[],CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FormUID;
/** @type {string} */
Name;
/** @type {string} */
Slug;
/** @type {string} */
Noun;
/** @type {string} */
NumberPrefix;
/** @type {string} */
Description;
/** @type {string} */
Tone;
/** @type {string} */
Status;
/** @type {?number} */
PublishedVersionNo;
/** @type {?string} */
PublishedAt;
/** @type {string} */
PublishedBy;
/** @type {boolean} */
DraftDirty;
/** @type {?string} */
DraftUpdatedAt;
/** @type {string} */
DraftUpdatedBy;
/** @type {string} */
PackLabel;
/** @type {string} */
SettingsJson;
/** @type {FormStats} */
Stats;
/** @type {string[]} */
Offered = [];
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
}
export class FormDetail extends FormCard {
/** @param {{DraftJson?:string,DraftRev?:number,SourceTemplateUID?:string,Warnings?:string[],AlwaysHidden?:string[],FormUID?:string,Name?:string,Slug?:string,Noun?:string,NumberPrefix?:string,Description?:string,Tone?:string,Status?:string,PublishedVersionNo?:number,PublishedAt?:string,PublishedBy?:string,DraftDirty?:boolean,DraftUpdatedAt?:string,DraftUpdatedBy?:string,PackLabel?:string,SettingsJson?:string,Stats?:FormStats,Offered?:string[],CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
DraftJson;
/** @type {number} */
DraftRev;
/** @type {?string} */
SourceTemplateUID;
/** @type {string[]} */
Warnings = [];
/** @type {string[]} */
AlwaysHidden = [];
}
export class FormResponse {
/** @param {{Form?:FormDetail,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FormDetail} */
Form;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class FormRestoreRequest {
/** @param {{FormUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FormUID;
}
JavaScript FormRestoreRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/forms/{FormUID}/restore HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormRestoreRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
</FormRestoreRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Form>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<Description>String</Description>
<DraftDirty>false</DraftDirty>
<DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
<DraftUpdatedBy>String</DraftUpdatedBy>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Name>String</Name>
<Noun>String</Noun>
<NumberPrefix>String</NumberPrefix>
<Offered xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Offered>
<PackLabel>String</PackLabel>
<PublishedAt>0001-01-01T00:00:00</PublishedAt>
<PublishedBy>String</PublishedBy>
<PublishedVersionNo>0</PublishedVersionNo>
<SettingsJson>String</SettingsJson>
<Slug>String</Slug>
<Stats>
<NeedDecision>0</NeedDecision>
<Overdue>0</Overdue>
<Total>0</Total>
<Waiting>0</Waiting>
</Stats>
<Status>String</Status>
<Tone>String</Tone>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<AlwaysHidden xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</AlwaysHidden>
<DraftJson>String</DraftJson>
<DraftRev>0</DraftRev>
<SourceTemplateUID>00000000-0000-0000-0000-000000000000</SourceTemplateUID>
<Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Warnings>
</Form>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</FormResponse>