GET /api/workflow/definitions/{WorkflowDefKey}

Returns information about the specified custom workflow.

Authorization Roles/Permissions: Must be logged in. Must have permission to view the business information: Business Admin or Site Admin

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for the workflow definition information for the specified custom workflow.

Sample Request URL

https://{hostname}/api/workflow/definitions/2f30136e-15d4-4797-8e64-8b9a0f4ea7d4

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
WorkflowDefKey	Path	string	Required	The unique workflow definition key for the applicable workflow.

Response

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

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Date: Wed, 11 Mar 2020 16:13:20 GMT
Content-Type: application/json

Sample response body

{
  "Key": "2f30136e-15d4-4797-8e64-8b9a0f4ea7d4",
  "Name": "API Version Custom Workflow Version 2",
  "Description": "API Version Custom Workflow Version 2",
  "State": "C",
  "ObjectType": "apiversion",
  "BusinessID": "tenantbusiness.acmepaymentscorp",
  "Updated": "2020-03-11T16:13:09Z"
}

Response Headers

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

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

Response Body

Name	Type	Description
WorkflowDefinition	WorkflowDefinition	Contains information about a workflow.

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.

Related Topics