PUT api/Workflows?workFlowName={workFlowName}

Execute the specified workflow against the specified enitity
Possible Service Responses:
200/OK - workflow process started against the specified entity.
404/Workflow Not Found - no workflow found for the specified id.
404/Entity Not Found - no entity found for the specified entity name and entity id.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workFlowName

The name of the workflow to execute

 System.String

Required

Body Parameters

The workflow defines the entity to execute the workflow against. AsynchronousOperationId - id of the operation started on successful, populated in the response. EntityId - id of the entity you want to run the workflow against for example the Id on the contact. EntityName - name of the entity you want to execute the workflow against for example "contact".

Altai.Web.Services.Models.Workflow
NameDescriptionTypeAdditional information
AsynchronousOperationId

System.String

None.
EntityId

System.String

None.
EntityName

System.String

None.

Request Formats

application/json, text/json

Sample: 
{
  "AsynchronousOperationId": "sample string 1",
  "EntityId": "sample string 2",
  "EntityName": "sample string 3"
}

application/xml, text/xml

Sample: 
<Workflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <AsynchronousOperationId>sample string 1</AsynchronousOperationId>
  <EntityId>sample string 2</EntityId>
  <EntityName>sample string 3</EntityName>
</Workflow>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.
Content

System.Net.Http.HttpContent

None.
StatusCode

System.Net.HttpStatusCode

None.
ReasonPhrase

System.String

None.
Headers

System.Net.Http.Headers.HttpResponseHeaders

None.
RequestMessage

System.Net.Http.HttpRequestMessage

None.
IsSuccessStatusCode

System.Boolean

None.