| GET,OPTIONS | /v1/workspace/modules |
|---|
"use strict";
export class ModuleLimit {
/** @param {{MeterKey?:string,Used?:number,Allowance?:number,IsReached?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
MeterKey;
/** @type {?number} */
Used;
/** @type {?number} */
Allowance;
/** @type {boolean} */
IsReached;
}
export class WorkspaceModuleFeature {
/** @param {{Key?:string,Name?:string,Enabled?:boolean,InPack?:boolean,Group?:string,Description?:string,IsOn?:boolean,Entitled?:boolean,Reason?:string,ModuleKey?:string,ModuleName?:string,ModuleStatus?:string,ModuleExpiresAt?:string,Limit?:ModuleLimit}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Name;
/** @type {boolean} */
Enabled;
/** @type {boolean} */
InPack;
/** @type {string} */
Group;
/** @type {string} */
Description;
/** @type {boolean} */
IsOn;
/** @type {boolean} */
Entitled;
/** @type {string} */
Reason;
/** @type {string} */
ModuleKey;
/** @type {string} */
ModuleName;
/** @type {string} */
ModuleStatus;
/** @type {?string} */
ModuleExpiresAt;
/** @type {ModuleLimit} */
Limit;
}
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 WorkspaceRequestMark {
/** @param {{Kind?:string,Key?:string,Features?:string[],RequestedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Kind;
/** @type {string} */
Key;
/** @type {string[]} */
Features = [];
/** @type {string} */
RequestedAt;
}
export class WorkspaceModulesResponse {
/** @param {{Modules?:WorkspaceModule[],PackName?:string,Requests?:WorkspaceRequestMark[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WorkspaceModule[]} */
Modules = [];
/** @type {string} */
PackName;
/** @type {WorkspaceRequestMark[]} */
Requests = [];
/** @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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Modules:
[
{
Key: String,
Name: String,
Letter: String,
Color: String,
Question: String,
Description: String,
Features:
[
{
Key: String,
Name: String,
Enabled: False,
InPack: False,
Group: String,
Description: String,
IsOn: False,
Entitled: False,
Reason: String,
ModuleKey: String,
ModuleName: String,
ModuleStatus: String,
ModuleExpiresAt: 0001-01-01,
Limit:
{
MeterKey: String,
Used: 0,
Allowance: 0,
IsReached: True
}
}
]
}
],
PackName: String,
Requests:
[
{
Kind: String,
Key: String,
Features:
[
String
],
RequestedAt: 0001-01-01
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}