GET /api/workflow/definitions
Retrieves information about all workflows defined on the platform.
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
Sample Request
The example below shows a request for the workflow definitions for the platform.
Request URL #1
Returns all workflows.
https://{hostname}/api/workflow/definitions
Request URL #2
Returns all workflows for tickets.
https://{hostname}/api/workflow/definitions?ObjectType=ticket
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 |
|---|---|---|---|---|
| BusinessID | Query | string | Optional | The unique ID for a specific business organization on the platform. |
| ObjectType | Query | string | Optional | The type of resource the workflow is for. For valid values, see Workflow Object Types. |
Response
If successful, this operation returns HTTP status code 200, with information about the workflow definitions for the platform.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers: application/json
Status Code: 200 OK Content-Type: application/json Expires: Mon, 09 Feb 2015 12:32:02 GMT
Sample response body: application/json
{
"channel" : {
"title" : "Workflow Definitions",
"description" : "tenantbusiness.acmepaymentscorp",
"item" : [ {
"title" : "workflow:definition:appversion-workflow-template1",
"description" : "App Version Workflow Template1",
"category" : [ {
"value" : "app-version",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:appversion-workflow-template1"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:apicontract",
"description" : "Default API Contract Workflow",
"category" : [ {
"value" : "apicontract",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:apicontract"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:comment",
"description" : "Default Comment Workflow",
"category" : [ {
"value" : "comment",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:comment"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:application-team-mbr",
"description" : "Default Application Team Member Workflow",
"category" : [ {
"value" : "grpmbrship",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:application-team-mbr"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:apicontract:v72",
"description" : "Default API Contract Workflow with Revise Support",
"category" : [ {
"value" : "apicontract",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:apicontract:v72"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:discussion",
"description" : "Default Discussion Workflow",
"category" : [ {
"value" : "discussion",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:discussion"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:review",
"description" : "Default Review Workflow",
"category" : [ {
"value" : "review",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:review"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:user",
"description" : "Default User Workflow",
"category" : [ {
"value" : "user",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:user"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:ticket",
"description" : "Default Ticket Workflow",
"category" : [ {
"value" : "ticket",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:ticket"
},
"pubDate" : "Mon, 09 Feb 2015 06:52:49 +0000"
}, {
"title" : "workflow:definition:oauth:grant:default:1.0.0",
"description" : "Default OAuth Grant Workflow",
"category" : [ {
"value" : "oauth-grant",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:oauth:grant:default:1.0.0"
},
"pubDate" : "Mon, 09 Feb 2015 06:58:56 +0000"
}, {
"title" : "workflow:definition:apicontract:laas-supplementaryconfig01",
"description" : "API Contract workflow with LaaS integration",
"category" : [ {
"value" : "apicontract",
"domain" : "soa.com:workflow.definition:object.type"
} ],
"guid" : {
"value" : "workflow:definition:apicontract:laas-supplementaryconfig01"
},
"pubDate" : "Mon, 09 Feb 2015 06:58:56 +0000"
} ]
},
"version" : "1.0"
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
The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is Workflow Definitions. Each item in the channel represents one workflow definition, and includes the information listed below.
| Name | Description |
|---|---|
| Title | Title of the workflow definition, as it displays on the selection list in the user interface: for example, workflow:definition:appversion-workflow-template1. |
| Description | Text description of the workflow definition: for example, App Version Workflow Template1. |
| Category | A name/value pair describing the categ |
| category[ ] |
A name/value pair describing the object type. For example: "value" : "app-version", "domain" : "soa.com:workflow.definition:object.type" The example above indicates that the workflow is for app versions. |
| GUID | GUID for the workflow definition. It is the same as the title. |
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 |
|---|---|
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.