POST /api/apis/versions/{ApiVersionID}/action

Executes a workflow action associated with a specific API version.

Note: To check what workflow actions are valid for the resource, use the GET /api/workflow/objects/{ObjectID}/actions operation.

Valid in version: 2019.1.7 and later

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API. To complete this operation successfully, a user must be a member of the applicable team. However, the workflow itself might enforce additional requirements.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/apis/versions/{ApiVersionID}/action

Sample Request

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

Sample Request URL 

https://{hostname}/api/models/versions/b063e194-3289-4438-90ea-a27b44e38965.acmepaymentscorp/action

Sample request headers 

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

Sample request body 

{
  "Comments":"Requesting approval.",
  "ActionName":"apiversion.action.submit.approval"
}

Request Headers

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

Header Description
Accept text/plain
Content-Type application/json
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
APIVersionID Path String Required The unique ID for a specific API version.
Action Body Action Required

Contains information about an action performed on a resource as part of a workflow-related activity. For information on possible values for groups, see API Versions: Valid Workflow Actions.

Additional actions might be defined in custom workflows.

Response

If successful, this operation returns HTTP status code 200, with the updated API workflow state value in the response.

Sample Response

The sample response below shows successful completion of this operation. The new workflow state for the API version is Pending Approval.

Sample response headers 

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Fri, 06 Mar 2020 21:50:40 GMT

Sample response body 

Pending Approval

Response Headers

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

Header Description
Content-Type text/plain

Response Body

Name Type Description
Response string

The updated workflow state for the resource. Valid API version states in this context:

  • Draft
  • Pending Approval
  • Active
  • Rejected
  • Deleted

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 would get this response if there is no custom workflow in place for API versions, therefore there is no list of valid workflow actions to return.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.