Trendsic Platform Service

<back to all web services

SetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/workspace/modules
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModuleFeature:
    key: Optional[str] = None
    name: Optional[str] = None
    enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModule:
    key: Optional[str] = None
    name: Optional[str] = None
    letter: Optional[str] = None
    color: Optional[str] = None
    question: Optional[str] = None
    description: Optional[str] = None
    features: List[WorkspaceModuleFeature] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModulesResponse:
    modules: List[WorkspaceModule] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceFeatureSelection:
    key: Optional[str] = None
    enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetWorkspaceModulesRequest:
    features: List[WorkspaceFeatureSelection] = field(default_factory=list)

Python SetWorkspaceModulesRequest 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.

PUT /v1/workspace/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Features":[{"Key":"String","Enabled":false}]}
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"}}}