POST Workflow/Install

install a new workflow from an xml template

Request Information

URI Parameters

None.

Body Parameters

the install workflow request object

WorkflowInstallRequest
NameDescriptionTypeAdditional information
XmlTemplate

string

None.

Request Formats

application/json, text/json

Sample:
{
  "XmlTemplate": "sample string 1"
}

text/html

Sample:
{"XmlTemplate":"sample string 1"}

application/xml, text/xml

Sample:
<WorkflowInstallRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Applus.EI.Workflow.Objects">
  <XmlTemplate>sample string 1</XmlTemplate>
</WorkflowInstallRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WorkflowInstallRequest'.

Response Information

Resource Description

the workflow id of the installed workflow

WorkflowInstallResponse
NameDescriptionTypeAdditional information
WorkflowId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "WorkflowId": 1
}

text/html

Sample:
{"WorkflowId":1}

application/xml, text/xml

Sample:
<WorkflowInstallResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Applus.EI.Workflow.Objects">
  <WorkflowId>1</WorkflowId>
</WorkflowInstallResponse>