Trendsic Platform Service

<back to all web services

EngineSandboxRequest

Requires Authentication
The following routes are available for this service:
POST/v1/engine/workflows/{WorkflowId}/test
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 WorkflowSandboxStepView:
    node_id: Optional[str] = None
    title: Optional[str] = None
    kind: Optional[str] = None
    outcome: Optional[str] = None
    detail: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowSandboxWriteView:
    what: Optional[str] = None
    detail: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineSandboxResponse:
    record: Optional[str] = None
    results: List[WorkflowSandboxStepView] = field(default_factory=list)
    suppressed: List[WorkflowSandboxWriteView] = field(default_factory=list)
    not_reached: List[str] = field(default_factory=list)
    unreachable: List[str] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EngineSandboxRequest:
    workflow_id: int = 0
    graph_json: Optional[str] = None

Python EngineSandboxRequest 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.

POST /v1/engine/workflows/{WorkflowId}/test HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkflowId: 0,
	GraphJson: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Record: String,
	Results: 
	[
		{
			NodeId: String,
			Title: String,
			Kind: String,
			Outcome: String,
			Detail: String
		}
	],
	Suppressed: 
	[
		{
			What: String,
			Detail: String
		}
	],
	NotReached: 
	[
		String
	],
	Unreachable: 
	[
		String
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}