Trendsic Platform Service

<back to all web services

EngineCatalogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/catalog
"use strict";
export class WorkflowCatalogItemView {
    /** @param {{Name?:string,Desc?:string,FieldsJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Desc;
    /** @type {string} */
    FieldsJson;
}
export class WorkflowCatalogGroupView {
    /** @param {{Vertical?:string,Color?:string,Pack?:string,Triggers?:WorkflowCatalogItemView[],Actions?:WorkflowCatalogItemView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Vertical;
    /** @type {string} */
    Color;
    /** @type {string} */
    Pack;
    /** @type {WorkflowCatalogItemView[]} */
    Triggers = [];
    /** @type {WorkflowCatalogItemView[]} */
    Actions = [];
}
export class EngineCatalogResponse {
    /** @param {{Groups?:WorkflowCatalogGroupView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowCatalogGroupView[]} */
    Groups = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class EngineCatalogRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript EngineCatalogRequest DTOs

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

HTTP + XML

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

GET /v1/engine/catalog HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineCatalogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Groups>
    <WorkflowCatalogGroupView>
      <Actions>
        <WorkflowCatalogItemView>
          <Desc>String</Desc>
          <FieldsJson>String</FieldsJson>
          <Name>String</Name>
        </WorkflowCatalogItemView>
      </Actions>
      <Color>String</Color>
      <Pack>String</Pack>
      <Triggers>
        <WorkflowCatalogItemView>
          <Desc>String</Desc>
          <FieldsJson>String</FieldsJson>
          <Name>String</Name>
        </WorkflowCatalogItemView>
      </Triggers>
      <Vertical>String</Vertical>
    </WorkflowCatalogGroupView>
  </Groups>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</EngineCatalogResponse>