Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness

export class FormReadinessCheck
{
    public Level: string;
    public Text: string;
    public FixTab: string;
    public FixFieldKey: string;
    public FixLabel: string;

    public constructor(init?: Partial<FormReadinessCheck>) { (Object as any).assign(this, init); }
}

export class FormReadinessResponse
{
    public Checks: FormReadinessCheck[] = [];
    public Changes: string[] = [];
    public NextVersion: number;
    public IsFirstPublish: boolean;
    public NothingChanged: boolean;
    public CanPublish: boolean;
    public DraftRev: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormReadinessResponse>) { (Object as any).assign(this, init); }
}

export class FormReadinessRequest
{
    public FormUID: string;

    public constructor(init?: Partial<FormReadinessRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}