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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowVersionInfo:
    version_num: int = 0
    status: Optional[str] = None
    created_by: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    published_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowView:
    workflow_id: int = 0
    source_key: Optional[str] = None
    name: Optional[str] = None
    vertical: Optional[str] = None
    pack: Optional[str] = None
    status: Optional[str] = None
    version_num: int = 0
    description: Optional[str] = None
    owner_role: Optional[str] = None
    graph_json: Optional[str] = None
    ok30: int = 0
    fail30: int = 0
    waiting: int = 0
    updated_by: Optional[str] = None
    updated_at: Optional[datetime.datetime] = None
    versions: List[WorkflowVersionInfo] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineWorkflowsResponse:
    workflows: List[WorkflowView] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineWorkflowsRequest:
    pass

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