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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<EngineSandboxRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GraphJson>String</GraphJson>
  <WorkflowId>0</WorkflowId>
</EngineSandboxRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineSandboxResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <NotReached xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NotReached>
  <Record>String</Record>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <WorkflowSandboxStepView>
      <Detail>String</Detail>
      <Kind>String</Kind>
      <NodeId>String</NodeId>
      <Outcome>String</Outcome>
      <Title>String</Title>
    </WorkflowSandboxStepView>
  </Results>
  <Suppressed>
    <WorkflowSandboxWriteView>
      <Detail>String</Detail>
      <What>String</What>
    </WorkflowSandboxWriteView>
  </Suppressed>
  <Unreachable xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Unreachable>
</EngineSandboxResponse>