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

GET

Back to top

URL

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

Back to top

Sample Request

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

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.

Back to top

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

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.

Back to top

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.

Back to top

Response

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

Back to top

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"
      } ]
    }
  } ]
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Date: Wed, 17 Jun 2015 00:49:30 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ApplicationVersions xmlns="http://soa.com/xsd/app/1.0" xmlns:ns2="http://soa.com/xsd/resource/1.0" 
xmlns:ns3="http://soa.com/xsd/dnmodel/1.0">
  <ApplicationVersion>
    <RuntimeID>92KnWI9uFCT82f0Esuvx9985.acmepaymentscorp</RuntimeID>
    <AppID>69763031-06ca-4f42-aead-71871cd64f3d.acmepaymentscorp</AppID>
    <Name>v3</Name>
    <Description>Paid version; extra features, no ads.</Description>
    <WebsiteAddress>http://www.crosfhocalsitedeluxe.com</WebsiteAddress>
    <Visibility>Public</Visibility>
    <InitialEnvironment>Sandbox</InitialEnvironment>
    <CurrentEnvironment>Sandbox</CurrentEnvironment>
    <Created>2015-06-17T00:36:48Z</Created>
    <Updated>2015-06-17T00:36:50Z</Updated>
    <State>com.soa.app.state.sandbox</State>
    <ns2:RatingSummary>
      <ns2:Five>0</ns2:Five>
      <ns2:Four>0</ns2:Four>
      <ns2:Three>0</ns2:Three>
      <ns2:Two>0</ns2:Two>
      <ns2:One>0</ns2:One>
    </ns2:RatingSummary>
    <Identity>acmepaymentscorp-92KnWI9uFCT82f0Esuvx9985</Identity>
    <ns3:TargetResources>
      <ns3:TargetResource>
        <ns3:Name>crosfhocal</ns3:Name>
        <ns3:ID>69763031-06ca-4f42-aead-71871cd64f3d.acmepaymentscorp</ns3:ID>
        <ns3:Type>app</ns3:Type>
      </ns3:TargetResource>
    </ns3:TargetResources>
  </ApplicationVersion>
</ApplicationVersions>

Back to top

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

Back to top

Response Body

Name Type Description
ApplicationVersions ApplicationVersions Contains information about one or more app versions.

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. 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.

Back to top

Related Topics