Trendsic Platform Service

<back to all web services

EngineRunsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/runs
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class EngineRunsRequest
            Public Overridable Property Status As String
            Public Overridable Property WorkflowId As Integer
            Public Overridable Property Top As Integer
        End Class

        Public Partial Class EngineRunsResponse
            Public Overridable Property Runs As List(Of WorkflowRunView) = New List(Of WorkflowRunView)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class WorkflowRunStepView
            Public Overridable Property StepId As Integer
            Public Overridable Property NodeId As String
            Public Overridable Property Name As String
            Public Overridable Property Kind As String
            Public Overridable Property Status As String
            Public Overridable Property DurationMs As Integer
            Public Overridable Property Input As String
            Public Overridable Property Output As String
            Public Overridable Property Note As String
            Public Overridable Property BranchReason As String
            Public Overridable Property Attempts As Integer
        End Class

        Public Partial Class WorkflowRunView
            Public Overridable Property RunId As Integer
            Public Overridable Property RunKey As String
            Public Overridable Property WorkflowId As Integer
            Public Overridable Property WorkflowName As String
            Public Overridable Property VersionNum As Integer
            Public Overridable Property Status As String
            Public Overridable Property RecordLabel As String
            Public Overridable Property RecordHref As String
            Public Overridable Property WaitReason As String
            Public Overridable Property RunAfter As Date?
            Public Overridable Property Attempts As Integer
            Public Overridable Property MaxAttempts As Integer
            Public Overridable Property StartedAt As Date
            Public Overridable Property FinishedAt As Date?
            Public Overridable Property DurationMs As Integer
            Public Overridable Property Steps As List(Of WorkflowRunStepView) = New List(Of WorkflowRunStepView)
        End Class
    End Namespace
End Namespace

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

<EngineRunsResponse 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>
  <Runs>
    <WorkflowRunView>
      <Attempts>0</Attempts>
      <DurationMs>0</DurationMs>
      <FinishedAt>0001-01-01T00:00:00</FinishedAt>
      <MaxAttempts>0</MaxAttempts>
      <RecordHref>String</RecordHref>
      <RecordLabel>String</RecordLabel>
      <RunAfter>0001-01-01T00:00:00</RunAfter>
      <RunId>0</RunId>
      <RunKey>String</RunKey>
      <StartedAt>0001-01-01T00:00:00</StartedAt>
      <Status>String</Status>
      <Steps>
        <WorkflowRunStepView>
          <Attempts>0</Attempts>
          <BranchReason>String</BranchReason>
          <DurationMs>0</DurationMs>
          <Input>String</Input>
          <Kind>String</Kind>
          <Name>String</Name>
          <NodeId>String</NodeId>
          <Note>String</Note>
          <Output>String</Output>
          <Status>String</Status>
          <StepId>0</StepId>
        </WorkflowRunStepView>
      </Steps>
      <VersionNum>0</VersionNum>
      <WaitReason>String</WaitReason>
      <WorkflowId>0</WorkflowId>
      <WorkflowName>String</WorkflowName>
    </WorkflowRunView>
  </Runs>
</EngineRunsResponse>