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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class EngineSandboxRequest
            Public Overridable Property WorkflowId As Integer
            Public Overridable Property GraphJson As String
        End Class

        Public Partial Class EngineSandboxResponse
            Public Overridable Property Record As String
            Public Overridable Property Results As List(Of WorkflowSandboxStepView) = New List(Of WorkflowSandboxStepView)
            Public Overridable Property Suppressed As List(Of WorkflowSandboxWriteView) = New List(Of WorkflowSandboxWriteView)
            Public Overridable Property NotReached As List(Of String) = New List(Of String)
            Public Overridable Property Unreachable As List(Of String) = New List(Of String)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class WorkflowSandboxStepView
            Public Overridable Property NodeId As String
            Public Overridable Property Title As String
            Public Overridable Property Kind As String
            Public Overridable Property Outcome As String
            Public Overridable Property Detail As String
        End Class

        Public Partial Class WorkflowSandboxWriteView
            Public Overridable Property What As String
            Public Overridable Property Detail As String
        End Class
    End Namespace
End Namespace

VB.NET 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>