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
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 WorkflowSandboxStepView() = 
        member val NodeId:String = null with get,set
        member val Title:String = null with get,set
        member val Kind:String = null with get,set
        member val Outcome:String = null with get,set
        member val Detail:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowSandboxWriteView() = 
        member val What:String = null with get,set
        member val Detail:String = null with get,set

    [<AllowNullLiteral>]
    type EngineSandboxResponse() = 
        member val Record:String = null with get,set
        member val Results:ResizeArray<WorkflowSandboxStepView> = new ResizeArray<WorkflowSandboxStepView>() with get,set
        member val Suppressed:ResizeArray<WorkflowSandboxWriteView> = new ResizeArray<WorkflowSandboxWriteView>() with get,set
        member val NotReached:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Unreachable:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type EngineSandboxRequest() = 
        member val WorkflowId:Int32 = new Int32() with get,set
        member val GraphJson:String = null with get,set

F# 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
		}
	}
}