Trendsic Platform Service

<back to all web services

EngineWorkflowsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/engine/workflows
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowVersionInfo() = 
        member val VersionNum:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val PublishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type WorkflowView() = 
        member val WorkflowId:Int32 = new Int32() with get,set
        member val SourceKey:String = null with get,set
        member val Name:String = null with get,set
        member val Vertical:String = null with get,set
        member val Pack:String = null with get,set
        member val Status:String = null with get,set
        member val VersionNum:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val OwnerRole:String = null with get,set
        member val GraphJson:String = null with get,set
        member val Ok30:Int32 = new Int32() with get,set
        member val Fail30:Int32 = new Int32() with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val UpdatedBy:String = null with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Versions:ResizeArray<WorkflowVersionInfo> = new ResizeArray<WorkflowVersionInfo>() with get,set

    [<AllowNullLiteral>]
    type EngineWorkflowsResponse() = 
        member val Workflows:ResizeArray<WorkflowView> = new ResizeArray<WorkflowView>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EngineWorkflowsRequest() = 
        class end

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

{
	Workflows: 
	[
		{
			WorkflowId: 0,
			SourceKey: String,
			Name: String,
			Vertical: String,
			Pack: String,
			Status: String,
			VersionNum: 0,
			Description: String,
			OwnerRole: String,
			GraphJson: String,
			Ok30: 0,
			Fail30: 0,
			Waiting: 0,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			Versions: 
			[
				{
					VersionNum: 0,
					Status: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					PublishedAt: 0001-01-01
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}