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 .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/engine/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Runs: 
	[
		{
			RunId: 0,
			RunKey: String,
			WorkflowId: 0,
			WorkflowName: String,
			VersionNum: 0,
			Status: String,
			RecordLabel: String,
			RecordHref: String,
			WaitReason: String,
			RunAfter: 0001-01-01,
			Attempts: 0,
			MaxAttempts: 0,
			StartedAt: 0001-01-01,
			FinishedAt: 0001-01-01,
			DurationMs: 0,
			Steps: 
			[
				{
					StepId: 0,
					NodeId: String,
					Name: String,
					Kind: String,
					Status: String,
					DurationMs: 0,
					Input: String,
					Output: String,
					Note: String,
					BranchReason: String,
					Attempts: 0
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}