POST /api/models/versions/{ModelVersionID}/action

Executes a workflow action on the specified model object.

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

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

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/models/versions/{ModelVersionID}/action

Sample Request

The example below shows a request for approval for the specified model object 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. This one is ready to go.",
  "ActionName":"model.action.submit.approval"
}

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
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
ModelVersionID Path String Required The unique ID for a specific version of a model object defined for a business organization. Same format as ModelID.
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, see All Groups: Valid Workflow Actions. ActionName is required.

Response

If successful, this operation returns HTTP status code 200, with the updated workflow status for the resource.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers 

HTTP/1.1 200 OK
Date: Thu, 16 May 2019 19:03:14 GMT
Content-Type: text/plain

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
Workflow state string

The updated workflow state for the resource. Valid states for a model:

  • Draft
  • Pending Approval
  • Active
  • Rejected

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.
406 Not Acceptable. Returned if there is a problem with the request format. For example, you would get this if you specified an incorrect media type for the Accept header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.