POST /api/workflow/definitions

Adds a new workflow for the developer portal.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the business information; Site Admin

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/workflow/definitions

Back to top

Sample Request

The example below shows a request to add a new workflow definition to the platform.

Request URL

https://{hostname}/api/workflow/definitions

Sample request headers

POST /api/workflow/definitions HTTP/1.1
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

The request body is the uploaded workflow document.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type multipart/form-data
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
InMultiPart Body multipart Required The XML workflow definition document. For more information, see Managing Multipart/Form-Data Uploads.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the new workflow definition.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Mon, 18 Jan 2016 19:17:14 GMT
Content-Type: text/html

Sample response body: application/json

{
  "Key":"768c81c4-fd75-4b5a-a2f2-8d5726fa820d",
  "Name":"User 2FA workflow",
  "Description":"User 2FA workflow",
  "State":"C",
  "ObjectType":"user",
  "BusinessID":"tenantbusiness.acmepaymentscorp",
  "Updated":"2016-01-18T11:17:15.088-08:00"
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
WorkflowDefinition WorkflowDefinition Contains information about a workflow.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics