Loading...

Executing a Workflow as an API (REST API: POST)

Description

This operation executes a workflow that looks like an API to the caller. To execute a workflow as a job, see Executing a Workflow as a Job.

For information on the Workflow API mode, see Setting General Properties.

Request

Syntax

POST <webservice>/wapi/{workflowName} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<inputs>
 <INPUT1>input_value</INPUT1>
 <INPUT2>input_value</INPUT2>
 <INPUT3>input_value</INPUT3>
 <INPUTN>input_value</INPUTN>
</inputs>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name Description Required
workflowName The name of the workflow. If the workflow name is not known, use the GET Workflow API to retrieve it. Yes

Request Headers

Name Description
Host The host name of the web server.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type The media type contained in the request body.

XML

An XML element is required if the workflow has workflow level inputs. See Syntax. The following table displays the parameters for the request body.

Name Description Elements
workflow_level_input_variable The value of the workflow level input needed to execute the workflow. Add an element for each input, for example:

<inputs>
 <INPUT1>input_value</INPUT1>
 <INPUT2>input_value</INPUT2>
 <INPUT3>input_value</INPUT3>
 <INPUTN>input_value</INPUTN>
</inputs>

where:

  • INPUT1 to INPUTN are the workflow level input variables
  • input_value is the value for the workflow level input variables defined as the element
inputs

Response

Response Parameters

Parameter Description Element
jobId The system-generated ID assigned to the job. Workflow_StartWorkflowResponse
processId The system-generated ID assigned to the process. Workflow_StartWorkflowResponse

Examples

Sample Request

POST <webservice>/wapi/CheckReadiness HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<inputs>
  <ClientGroupName>Media Agents</ClientGroupName>
</inputs>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Workflow_StartWorkflowResponse jobId="234" processId="234"/>