Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/workspace/modules
WorkspaceModulesResponse Parameters:
NameParameterData TypeRequiredDescription
ModulesformList<WorkspaceModule>No
PackNameformstringNo
RequestsformList<WorkspaceRequestMark>No
ResponseStatusformResponseStatusNo
WorkspaceModule Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
LetterformstringNo
ColorformstringNo
QuestionformstringNo
DescriptionformstringNo
FeaturesformList<WorkspaceModuleFeature>No
WorkspaceModuleFeature Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
EnabledformboolNo
InPackformboolNo
GroupformstringNo
DescriptionformstringNo
IsOnformboolNo
EntitledformboolNo
ReasonformstringNo
ModuleKeyformstringNo
ModuleNameformstringNo
ModuleStatusformstringNo
ModuleExpiresAtformDateTime?No
LimitformModuleLimitNo
ModuleLimit Parameters:
NameParameterData TypeRequiredDescription
MeterKeyformstringNo
Usedformlong?No
Allowanceformint?No
IsReachedformboolNo
WorkspaceRequestMark Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
KeyformstringNo
FeaturesformList<string>No
RequestedAtformDateTimeNo

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/workspace/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","Limit":{"MeterKey":"String","Used":0,"Allowance":0,"IsReached":true}}]}],"PackName":"String","Requests":[{"Kind":"String","Key":"String","Features":["String"],"RequestedAt":"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"}}}