Trendsic Platform Service

GetWorkspaceModulesRequest

The following routes are available for this service:
GET,OPTIONS	/v1/workspace/modules


export class ModuleLimit
{
    public MeterKey: string;
    public Used?: number;
    public Allowance?: number;
    public IsReached: boolean;

    public constructor(init?: Partial<ModuleLimit>) { (Object as any).assign(this, init); }
}

export class WorkspaceModuleFeature
{
    public Key: string;
    public Name: string;
    public Enabled: boolean;
    public InPack: boolean;
    public Group: string;
    public Description: string;
    public IsOn: boolean;
    public Entitled: boolean;
    public Reason: string;
    public ModuleKey: string;
    public ModuleName: string;
    public ModuleStatus: string;
    public ModuleExpiresAt?: string;
    public Limit: ModuleLimit;

    public constructor(init?: Partial<WorkspaceModuleFeature>) { (Object as any).assign(this, init); }
}

export class WorkspaceModule
{
    public Key: string;
    public Name: string;
    public Letter: string;
    public Color: string;
    public Question: string;
    public Description: string;
    public Features: WorkspaceModuleFeature[] = [];

    public constructor(init?: Partial<WorkspaceModule>) { (Object as any).assign(this, init); }
}

export class WorkspaceRequestMark
{
    public Kind: string;
    public Key: string;
    public Features: string[] = [];
    public RequestedAt: string;

    public constructor(init?: Partial<WorkspaceRequestMark>) { (Object as any).assign(this, init); }
}

export class WorkspaceModulesResponse
{
    public Modules: WorkspaceModule[] = [];
    public PackName: string;
    public Requests: WorkspaceRequestMark[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<WorkspaceModulesResponse>) { (Object as any).assign(this, init); }
}

export class GetWorkspaceModulesRequest
{

    public constructor(init?: Partial<GetWorkspaceModulesRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetWorkspaceModulesRequest DTOs

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

HTTP + 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
		}
	}
}