Trendsic Platform Service

<back to all web services

FormListRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms
"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 FormListResponse {
    /** @param {{Forms?:FormCard[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormCard[]} */
    Forms = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormListRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript FormListRequest DTOs

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

HTTP + CSV

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

GET /v1/forms HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

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

{"Forms":[{"FormUID":"00000000000000000000000000000000","Name":"String","Slug":"String","Noun":"String","NumberPrefix":"String","Description":"String","Tone":"String","Status":"String","PublishedVersionNo":0,"PublishedAt":"0001-01-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}