Trendsic Platform Service

<back to all web services

EngineWorkflowsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/workflows

export class WorkflowVersionInfo
{
    public VersionNum: number;
    public Status: string;
    public CreatedBy: string;
    public CreatedAt: string;
    public PublishedAt?: string;

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

export class WorkflowView
{
    public WorkflowId: number;
    public SourceKey: string;
    public Name: string;
    public Vertical: string;
    public Pack: string;
    public Status: string;
    public VersionNum: number;
    public Description: string;
    public OwnerRole: string;
    public GraphJson: string;
    public Ok30: number;
    public Fail30: number;
    public Waiting: number;
    public UpdatedBy: string;
    public UpdatedAt?: string;
    public Versions: WorkflowVersionInfo[] = [];

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

export class EngineWorkflowsResponse
{
    public Workflows: WorkflowView[] = [];
    public ResponseStatus: ResponseStatus;

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

export class EngineWorkflowsRequest
{

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

TypeScript EngineWorkflowsRequest 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/workflows HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineWorkflowsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Workflows>
    <WorkflowView>
      <Description>String</Description>
      <Fail30>0</Fail30>
      <GraphJson>String</GraphJson>
      <Name>String</Name>
      <Ok30>0</Ok30>
      <OwnerRole>String</OwnerRole>
      <Pack>String</Pack>
      <SourceKey>String</SourceKey>
      <Status>String</Status>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UpdatedBy>String</UpdatedBy>
      <VersionNum>0</VersionNum>
      <Versions>
        <WorkflowVersionInfo>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <PublishedAt>0001-01-01T00:00:00</PublishedAt>
          <Status>String</Status>
          <VersionNum>0</VersionNum>
        </WorkflowVersionInfo>
      </Versions>
      <Vertical>String</Vertical>
      <Waiting>0</Waiting>
      <WorkflowId>0</WorkflowId>
    </WorkflowView>
  </Workflows>
</EngineWorkflowsResponse>