Trendsic Platform Service

<back to all web services

EngineRunsRequest

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class EngineRunsRequest
    {
        public virtual string Status { get; set; }
        public virtual int WorkflowId { get; set; }
        public virtual int Top { get; set; }
    }

    public partial class EngineRunsResponse
    {
        public virtual List<WorkflowRunView> Runs { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class WorkflowRunStepView
    {
        public virtual int StepId { get; set; }
        public virtual string NodeId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Status { get; set; }
        public virtual int DurationMs { get; set; }
        public virtual string Input { get; set; }
        public virtual string Output { get; set; }
        public virtual string Note { get; set; }
        public virtual string BranchReason { get; set; }
        public virtual int Attempts { get; set; }
    }

    public partial class WorkflowRunView
    {
        public virtual int RunId { get; set; }
        public virtual string RunKey { get; set; }
        public virtual int WorkflowId { get; set; }
        public virtual string WorkflowName { get; set; }
        public virtual int VersionNum { get; set; }
        public virtual string Status { get; set; }
        public virtual string RecordLabel { get; set; }
        public virtual string RecordHref { get; set; }
        public virtual string WaitReason { get; set; }
        public virtual DateTime? RunAfter { get; set; }
        public virtual int Attempts { get; set; }
        public virtual int MaxAttempts { get; set; }
        public virtual DateTime StartedAt { get; set; }
        public virtual DateTime? FinishedAt { get; set; }
        public virtual int DurationMs { get; set; }
        public virtual List<WorkflowRunStepView> Steps { get; set; } = [];
    }

}

C# 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>