GET /api/apps/versions/{AppVersionID}/governingworkflow

Returns information about the workflow governing the specified app version.

Authorization Roles/Permissions: Site Admin or Business Admin

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/governingworkflow

Back to top

Sample Request

The example below shows a request for workflow information for the specified app version.

Request URL

https://{hostname}/api/apps/versions/5ePhotP0MBr9qPxjFClKbt98.acmepaymentscorp/governingworkflow

Sample request headers

Accept: application/json
X-Csrf-Token_{tenant}: {TokenID}

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
AppVersionID Path string Required The unique ID for a specific app version.

Back to top

Response

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

Back to top

Sample Response

Sample response headers: application/json

200 OK
Content-Type: application/json
Date: Thu, 06 Feb 2014 22:59:11 GMT

Sample response body: application/json #1

In the example response below, the resource is not governed by a workflow.

{
  "Governed" : false
}

Sample response body: application/json #2

In the example below, the resource is governed by a workflow, so the operation returns information about the workflow.

{
  "Governed" : true,
  "Key" : "7ccf9300-9def-4de0-b1b1-7b012f845d35",
  "Name" : "Custom app workflow",
  "Description" : "Custom app workflow",
  "Updated" : "2014-02-06T22:51:35Z"
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: text/html;charset=ISO-8859-1
Date: Thu, 06 Feb 2014 22:53:56 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<ns2:GoverningWorkflow xmlns="http://soa.com/xsd/user/1.0" xmlns:ns2="http://soa.com/xsd/workflow/1.0">
  <ns2:Governed>true</ns2:Governed>
  <ns2:Key>3f355b25-d0f1-4782-90bf-506fa2da5d67</ns2:Key>
  <ns2:Name>App workflow 1 Sandbox Only</ns2:Name>
  <ns2:Description>App workflow 1 Sandbox Only</ns2:Description>
  <ns2:Updated>2014-02-07T16:57:07Z</ns2:Updated>
</ns2:GoverningWorkflow>

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

Name Type Description
GoverningWorkflow GoverningWorkflow Contains information about the custom workflow, if any, governing the specified resource.

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.
404 The resource could not be found. For example, you might get this if you included an invalid AppVersionID in the request.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics