DELETE /api/apps/versions/{AppVersionID}

Deletes the specified version of an app.

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: App team member, Business Admin

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

Sample Request

The example below deletes the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/1zPOeamQxXm1jzm1CPNvoP7H.acmepaymentscorp

Sample request headers

DELETE /api/apps/versions/1zPOeamQxXm1jzm1CPNvoP7H.acmepaymentscorp HTTP/1.1
Host:{hostname}
Accept: */*
Content-Type: application/x-www-form-urlencoded
X-Csrf-Token_{tenant}: {TokenID}

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 Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*. Also application/vnd.soa.v72+json, application/vnd.soa.v80+json
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.
Comment Query string Required A comment entered by the user performing the action.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the AppVersionID of the deleted app as confirmation.

Back to top

Sample Response

The sample response below shows the AppVersionID of the deleted app version.

Sample response headers

HTTP/1.1 200 OK
Date: Mon, 16 Jul 2012 21:44:32 GMT
Content-Type: text/plain
Atmo-Renew-Token: renew

Sample response body#1

1zPOeamQxXm1jzm1CPNvoP7H.acmepaymentscorp

Sample response body#2

{
  "RuntimeID" : "6EWkvFemCKn2lsUMw41p1uAs.acmepaymentscorp",
  "AppID" : "d811aac7-b9c0-4752-9761-c76c86fd94cd.acmepaymentscorp",
  "Name" : "s",
  "Description" : "s",
  "WebsiteAddress" : "",
  "Visibility" : "Public",
  "InitialEnvironment" : "Sandbox",
  "CurrentEnvironment" : "Sandbox",
  "Created" : "2016-01-04T21:16:22Z",
  "Updated" : "2016-01-04T21:16:39Z",
  "State" : "com.soa.app.state.deleted",
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  }
}

Back to top

Response Headers

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

Header Description
Content-Type text/plain, application/vnd.soa.v72+json, application/vnd.soa.v80+json
Atmo-Renew-Token renew

Back to top

Response Body

Name Type Description
AppVersionID string The unique ID for a specific app version.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics