Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness
"use strict";
export class FormReadinessCheck {
    /** @param {{Level?:string,Text?:string,FixTab?:string,FixFieldKey?:string,FixLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Level;
    /** @type {string} */
    Text;
    /** @type {string} */
    FixTab;
    /** @type {string} */
    FixFieldKey;
    /** @type {string} */
    FixLabel;
}
export class FormReadinessResponse {
    /** @param {{Checks?:FormReadinessCheck[],Changes?:string[],NextVersion?:number,IsFirstPublish?:boolean,NothingChanged?:boolean,CanPublish?:boolean,DraftRev?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormReadinessCheck[]} */
    Checks = [];
    /** @type {string[]} */
    Changes = [];
    /** @type {number} */
    NextVersion;
    /** @type {boolean} */
    IsFirstPublish;
    /** @type {boolean} */
    NothingChanged;
    /** @type {boolean} */
    CanPublish;
    /** @type {number} */
    DraftRev;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormReadinessRequest {
    /** @param {{FormUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
}

JavaScript FormReadinessRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/forms/{FormUID}/readiness HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Checks":[{"Level":"String","Text":"String","FixTab":"String","FixFieldKey":"String","FixLabel":"String"}],"Changes":["String"],"NextVersion":0,"IsFirstPublish":false,"NothingChanged":false,"CanPublish":false,"DraftRev":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}