GET /api/workflow/definitions

Retrieves information about all workflows defined on the platform.

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

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

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.

Back to top

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
ObjectType Query string Optional The type of resource the workflow is for. For valid values, see Workflow Object Types.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the workflow definitions for the platform.

Back to top

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"

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Mon, 09 Feb 2015 12:34:26 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/rss/1.0" 
xmlns:ns4="http://soa.com/xsd/user/1.0" xmlns:ns5="http://soa.com/xsd/comment/1.0" 
xmlns:ns6="http://soa.com/xsd/dnmodel/1.0" xmlns:ns7="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns8="http://soa.com/xsd/resource/1.0" xmlns:ns9="http://soa.com/xsd/legals/1.0" 
xmlns:ns10="http://soa.com/xsd/fault/1.0" xmlns:ns11="http://soa.com/xsd/api/1.0" 
xmlns:ns12="http://soa.com/xsd/board/1.0" xmlns:ns13="http://soa.com/xsd/review/1.0" 
xmlns:ns14="http://soa.com/xsd/ticket/1.0" xmlns:ns15="http://soa.com/xsd/app/1.0" 
xmlns:ns16="http://soa.com/xsd/discussion/1.0" xmlns:ns17="http://soa.com/xsd/alert/1.0" 
xmlns:ns18="http://soa.com/xsd/contract/1.0" xmlns:ns19="http://soa.com/xsd/search/1.0" 
xmlns:ns20="http://soa.com/xsd/workflow/1.0" version="1.0">
  <channel>
    <title>Workflow Definitions</title>
    <description>tenantbusiness.acmepaymentscorp</description>
    <item>
      <title>workflow:definition:oauth:grant:default:1.0.0</title>
      <description>Default OAuth Grant Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">oauth-grant</category>
      <guid>workflow:definition:oauth:grant:default:1.0.0</guid>
      <pubDate>Mon, 09 Feb 2015 06:58:56 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:user</title>
      <description>Default User Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">user</category>
      <guid>workflow:definition:user</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:apicontract:laas-supplementaryconfig01</title>
      <description>API Contract workflow with LaaS integration</description>
      <category domain="soa.com:workflow.definition:object.type">apicontract</category>
      <guid>workflow:definition:apicontract:laas-supplementaryconfig01</guid>
      <pubDate>Mon, 09 Feb 2015 06:58:56 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:comment</title>
      <description>Default Comment Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">comment</category>
      <guid>workflow:definition:comment</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:appversion-workflow-template1</title>
      <description>App Version Workflow Template1</description>
      <category domain="soa.com:workflow.definition:object.type">app-version</category>
      <guid>workflow:definition:appversion-workflow-template1</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:discussion</title>
      <description>Default Discussion Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">discussion</category>
      <guid>workflow:definition:discussion</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:apicontract:v72</title>
      <description>Default API Contract Workflow with Revise Support</description>
      <category domain="soa.com:workflow.definition:object.type">apicontract</category>
      <guid>workflow:definition:apicontract:v72</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:review</title>
      <description>Default Review Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">review</category>
      <guid>workflow:definition:review</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:application-team-mbr</title>
      <description>Default Application Team Member Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">grpmbrship</category>
      <guid>workflow:definition:application-team-mbr</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:ticket</title>
      <description>Default Ticket Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">ticket</category>
      <guid>workflow:definition:ticket</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
    <item>
      <title>workflow:definition:apicontract</title>
      <description>Default API Contract Workflow</description>
      <category domain="soa.com:workflow.definition:object.type">apicontract</category>
      <guid>workflow:definition:apicontract</guid>
      <pubDate>Mon, 09 Feb 2015 06:52:49 +0000</pubDate>
    </item>
  </channel>
</rss>

Back to top

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

Back to top

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 isWorkflow 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.

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
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics