POST /api/apps/versions/{AppVersionID}/action

Executes a workflow action associated with a specific app version.

Applicable if a custom app version workflow has been uploaded and assigned as the active workflow for apps.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the app. 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/apps/versions/{AppVersionID}/action

Sample Request

The example below shows a request to regenerate the Shared Secret for the app.

Sample Request URL

https://{hostname}/api/apps/versions/Qlz1e9RifAoljKaTh8ArLaRl3ZaZTCTw4h6kVx8D.acmepaymentscorp/action

Sample request headers

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

Sample request body

{
  "ActionName": "@RegeneratedSecret"
}

Request Headers

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

Header	Description
Accept	text/plain
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
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
AppVersionID	Path	string	Required	The unique ID for a specific app version.

Response

If successful, this operation returns HTTP status code 200, with the API VersionID in the response.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Fri, 18 Sep 2020 14:01:27 GMT

Sample response body

Qlz1e9RifAoljKaTh8ArLaRl3ZaZTCTw4h6kVx8D.acmepaymentscorp

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

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

More information about Akana API Platform API error messages.

Related Topics