Trendsic Platform Service

<back to all web services

EngineWorkflowsRequest

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

public class EngineWorkflowsRequest : Codable
{
    required public init(){}
}

public class EngineWorkflowsResponse : Codable
{
    public var workflows:[WorkflowView] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WorkflowView : Codable
{
    public var workflowId:Int
    public var sourceKey:String
    public var name:String
    public var vertical:String
    public var pack:String
    public var status:String
    public var versionNum:Int
    public var Description:String
    public var ownerRole:String
    public var graphJson:String
    public var ok30:Int
    public var fail30:Int
    public var waiting:Int
    public var updatedBy:String
    public var updatedAt:Date?
    public var versions:[WorkflowVersionInfo] = []

    required public init(){}
}

public class WorkflowVersionInfo : Codable
{
    public var versionNum:Int
    public var status:String
    public var createdBy:String
    public var createdAt:Date
    public var publishedAt:Date?

    required public init(){}
}


Swift 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
		}
	}
}