DELETE /api/apps/versions/{AppVersionID}

Deletes the specified version of an app (returns JSON) (recommended).

Note: If you want to completely remove an app, use DELETE /api/apps/{AppID}. If you want to delete the only existing app version, but keep the app, first add a new version, using POST /api/apps/{AppID}/versions, and then delete the old version using DELETE /api/apps/versions/{AppVersionID}. An app cannot exist in the Akana API Platform without at least one valid version.

Workflow: This operation checks whether the resource is governed by a workflow, and if so whether the action is valid based on the current state of the resource. If the action is not valid, the operation will fail.

Authorization Roles/Permissions: Must be logged in. Must have permission to delete the app. App team member, Business Admin

This topic includes the following sections:

HTTP Method

DELETE

URL

https://{hostname}/api/apps/versions/{AppVersionID}[?Comment={Comment}]

Sample Request

The example below deletes the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/2yuP6j9OtQHjJMtc5dddRqpTOs4FiXMC9RzQWzKp.acmepaymentscorp?Comment=Deleting%20old%20version.

Sample request headers

DELETE /api/apps/versions/2yuP6j9OtQHjJMtc5dddRqpTOs4FiXMC9RzQWzKp.acmepaymentscorp?Comment=Deleting%20old%20version. HTTP/1.1
Host:{hostname}
Accept: */*
Content-Type: application/x-www-form-urlencoded
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	Valid in version 2020.1.0 and later: application/json Valid in all versions: application/vnd.soa.v72+json, application/vnd.soa.v80+json
Content-Type	Any format (*/*)
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.
Comment	Query	string	Optional	A comment entered by the user performing the action.

Response

If successful, this operation returns HTTP status code 200, with information about the deleted app version.

Sample Response

The sample response below shows a successful result.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 25 Nov 2020 22:10:55 GMT
Content-Type: application/vnd.soa.v80+json
Atmo-Renew-Token: renew

Sample response body

{
  "RuntimeID":"2yuP6j9OtQHjJMtc5dddRqpTOs4FiXMC9RzQWzKp.acmepaymentscorp",
  "AppID":"47a95b38-4687-4a62-9418-1bf2bba86b45.acmepaymentscorp",
  "Name":"1.0",
  "Description":"Initial version",
  "WebsiteAddress":"http://www.acmepaymentscorp.com/crosfhocal",
  "Visibility":"Public",
  "InitialEnvironment":"Sandbox",
  "CurrentEnvironment":"Sandbox",
  "Created":"2020-11-25T22:08:15Z",
  "Updated":"2020-11-25T22:10:56Z",
  "State":"com.soa.app.state.deleted",
  "RatingSummary":{
    "Five":0,
    "Four":0,
    "Three":0,
    "Two":0,
    "One":0
  }
}

Response Headers

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

Header	Description
Content-Type	Valid in version 2020.1.0 and later: application/json Valid in all versions: application/vnd.soa.v72+json, application/vnd.soa.v80+json
Atmo-Renew-Token	renew

Response Body

Name	Type	Description
ApplicationVersion	ApplicationVersion	Contains information about a version of an app.

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