Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/workspace/modules
"use strict";
export class WorkspaceModuleFeature {
    /** @param {{Key?:string,Name?:string,Enabled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Enabled;
}
export class WorkspaceModule {
    /** @param {{Key?:string,Name?:string,Letter?:string,Color?:string,Question?:string,Description?:string,Features?:WorkspaceModuleFeature[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {string} */
    Letter;
    /** @type {string} */
    Color;
    /** @type {string} */
    Question;
    /** @type {string} */
    Description;
    /** @type {WorkspaceModuleFeature[]} */
    Features = [];
}
export class WorkspaceModulesResponse {
    /** @param {{Modules?:WorkspaceModule[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkspaceModule[]} */
    Modules = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetWorkspaceModulesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetWorkspaceModulesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/workspace/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Modules":[{"Key":"String","Name":"String","Letter":"String","Color":"String","Question":"String","Description":"String","Features":[{"Key":"String","Name":"String","Enabled":false}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}