GET /api/apps/versions?Identity={identity}

Returns information about app versions, for the ID specified in the required Identity parameter. You can use this operation to get the AppID or AppVersionID if you only have the AppID specified on the App Details Page in the user interface.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/apps/versions?Identity={identity}

Sample Request

The example below shows a request for the app versions for the specified app identity.

Sample Request URL

https://{hostname}/api/apps/versions?Identity=acmepaymentscorp-92KnWI9uFCT82f0Esuvx9985

Sample request headers

Accept: application/vnd.soa.v72+json
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	application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, 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.

Header

Description

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

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
Identity	Path	string	Required	The runtime identity of an application version. In the platform user interface, the runtime identity is displayed on the App Details page. It could either be the system-generated AppID or AppVersion ID, or it could be an ID specified by the user when adding the app or an app version.

Response

If successful, this operation returns HTTP status code 200, with information about the app versions for the specified app identity.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+json
Date: Wed, 17 Jun 2015 00:39:58 GMT

Sample response body: application/json

{
  "ApplicationVersion" : [ {
    "RuntimeID" : "92KnWI9uFCT82f0Esuvx9985.acmepaymentscorp",
    "AppID" : "69763031-06ca-4f42-aead-71871cd64f3d.acmepaymentscorp",
    "Name" : "v3",
    "Description" : "Paid version; extra features, no ads.",
    "WebsiteAddress" : "http://www.crosfhocalsitedeluxe.com",
    "Visibility" : "Public",
    "InitialEnvironment" : "Sandbox",
    "CurrentEnvironment" : "Sandbox",
    "Created" : "2015-06-17T00:36:48Z",
    "Updated" : "2015-06-17T00:36:50Z",
    "State" : "com.soa.app.state.sandbox",
    "RatingSummary" : {
      "Five" : 0,
      "Four" : 0,
      "Three" : 0,
      "Two" : 0,
      "One" : 0
    },
    "Identity" : "acmepaymentscorp-92KnWI9uFCT82f0Esuvx9985",
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "crosfhocal",
        "ID" : "69763031-06ca-4f42-aead-71871cd64f3d.acmepaymentscorp",
        "Type" : "app"
      } ]
    }
  } ]
}

Response Headers

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

Header	Description
Content-Type	application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml