GET /api/apis/versions/{APIVersionID}/governingworkflow

Returns information about the workflow governing the specified API version.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/governingworkflow

Back to top

Sample Request

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

Request URL

https://{hostname}/api/apis/versions/55af28d8-1b31-44b2-8566-597cc772a204.acmepaymentscorp/governingworkflow

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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

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
APIVersionID Path string Required The unique ID for a specific API 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

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 06 Feb 2014 22:34:59 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 b y a workflow, so the operation returns information about the workflow.

{
  "Governed" : true,
  "Key" : "7df574bb-a647-446b-b0e5-fa4c3ef84304",
  "Name" : "API workflow",
  "Description" : "API workflow",
  "Updated" : "2014-02-06T19:58:17Z"
}

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:30:01 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>7df574bb-a647-446b-b0e5-fa4c3ef84304</ns2:Key>
  <ns2:Name>API workflow</ns2:Name>
  <ns2:Description>API workflow</ns2:Description>
  <ns2:Updated>2014-02-06T19:58:17Z</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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404 The resource could not be found. For example, you might get this if you include an invalid APIVersionID.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics