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

Returns app version information, including the AppVersionID, based on the Identity value provided.

This operation provides a bridge so that if you have the Identity value you can retrieve the AppVersionID, which is used by most of the operations in the Apps service. With the AppVersionID you can run other operations in the service.

For a full list of operations and their signatures see Apps Service: Overview.

Authorization Roles/Permissions: Must be logged in. App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for the version information for the specified identity value.

Sample Request URL

https://{hostname}/api/apps/versions?Identity=acmepaymentscorp-4iXro2Uxs2h4LviCshR9pK9w

Sample request headers

Accept: application/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	text/xml, application/xml, application/json, application/vnd.soa.v71+json, application/vnd.soa.v71+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
Identity	Query	string	Optional	The identity name for the app version, if applicable.

Response

If successful, this operation returns HTTP status code 200, with information about the app versions. The information is returned in the form of an RSS channel.

Sample Response

The sample response below shows successful completion of this operation. There is one version.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 03 Jul 2013 20:12:39 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Application versions",
    "item" : [ {
      "title" : "2.0",
      "description" : "Created 2/4/13",
      "category" : [ {
        "value" : "app-version",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Sandbox",
        "domain" : "uddi:soa.com:environment"
      }, {
        "value" : "com.soa.app.state.sandbox",
        "domain" : "uddi:soa.com:application.state"
      } ],
      "guid" : {
        "value" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp"
      },
      "pubDate" : "Tue, 04 Jun 2013 19:38:55 +0000",
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "PaaStime",
          "Guid" : "app16964.acmepaymentscorp",
          "Category" : [ {
            "value" : "app",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Response Headers

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

Header	Description
Content-Type	text/xml, application/xml, application/json, application/vnd.soa.v71+json, application/vnd.soa.v71+xml

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is Application versions. Each item in the channel represents one app version, and includes the information listed below.

Name	Description
title	Version number.
description	Description of the app version.
category[ ]	An array of sets of two name/value pairs, each including Value and Domain, with a value for each. A category for the "uddi:soa.com:resourcetype" domain is provided with the value "App Version". A second category for the "uddi:soa.com:tag" domain is provided for each tag assigned to the app version. A third category for the "uddi:soa.com:application.state" domain is provided with the value representing the version's state. There is also a name/value pair for each tag assigned to the app version. For information regarding app state, refer to Determining the State Value of an App.
guid	App version ID.
pubDate	A date/time stamp identifying when the app version was last updated.
EntityReference	Reference to the app for which versions are being retrieved: Title, which is the app name, GUID, the unique AppID, and Category indicating the resource type is 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