GET /api/apps/versions/{AppVersionID}

Returns a version of an app.

Authorization Roles/Permissions: App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}

Back to top

Sample Request

The example below requests the version information for the ID in the URL.

Sample request URL #1

https://{hostname}/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp

Sample request URL #2

https://{hostname}/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp?IncludeSettings=true

Sample request headers

Accept: application/json, text/javascript, */*; q=0.01
Host:{hostname}
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 application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.
IncludeSettings Query boolean Optional Indicates whether the settings for the resource should be included in the response. If not specified, defaults to false.
IncludeTags Query boolean Optional Indicates whether tags should be returned in the response. If not specified, defaults to true.
IncludeSecurityMechanism Query boolean Optional Indicates whether security mechanisms should be returned in the response. If not specified, defaults to true.
IdentityAppDeploymentState Query boolean Optional Indicates whether the app's deployment state should be returned in the response. If not specified, defaults to true.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the version information in a JSON or XML object.

Back to top

Sample Response

The example below shows the response for version 2.0 of an app.

Sample response headers

Content-Type: application/json
Date: Fri, 31 May 2013 18:24:07 GMT

Sample response body #1

{
  "RuntimeID" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
  "AppID" : "app16964.acmepaymentscorp",
  "Name" : "2.0",
  "Description" : "Created 2/4/13",
  "WebsiteAddress" : "",
  "Visibility" : "Limited",
  "InitialEnvironment" : "Sandbox",
  "CurrentEnvironment" : "Sandbox",
  "Tag" : [ ],
  "HasKeyInfo" : true,
  "Created" : "2013-02-04T19:22:50Z",
  "Updated" : "2013-05-23T22:14:30Z",
  "State" : "com.soa.app.state.sandbox",
  "SecurityMechanisms" : [ "com.soa.security.mechanism.pki", "com.soa.security.mechanism.sharedsecret" ],
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 1,
    "Two" : 0,
    "One" : 0
  },
  "Identity" : "acmepaymentscorp-4iXro2Uxs2h4LviCshR9pK9w"
}

Sample response body #2

IncludeSettings parameter was set to true in the request, so app version settings are included in the response.

{
  "RuntimeID" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
  "AppID" : "app16964.acmepaymentscorp",
  "Name" : "2.0",
  "Description" : "Created 2/4/13",
  "WebsiteAddress" : "",
  "Visibility" : "Limited",
  "InitialEnvironment" : "Sandbox",
  "CurrentEnvironment" : "Sandbox",
  "Tag" : [ ],
  "HasKeyInfo" : true,
  "Created" : "2013-02-04T19:22:50Z",
  "Updated" : "2013-06-04T19:38:55Z",
  "State" : "com.soa.app.state.sandbox",
  "SecurityMechanisms" : [ "com.soa.security.mechanism.pki", "com.soa.security.mechanism.sharedsecret" ],
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 1,
    "Two" : 0,
    "One" : 0
  },
  "Identity" : "acmepaymentscorp-4iXro2Uxs2h4LviCshR9pK9w",
  "AppVersionSettings" : {
    "AppBoardSupport" : "com.soa.feature.enabled",
    "AppRatingsSupport" : "com.soa.feature.enabled",
    "AppReviewsSupport" : "com.soa.feature.enabled",
    "UserDefinedIdentitySupport" : "com.soa.feature.enabled.for.siteadmins",
    "SimultaneousSandboxProductAccessSupport" : "com.soa.feature.enabled"
  }
}

Sample response body #3: domain included in user-defined Identity field

In the example below, the app has a user-defined App Identity that includes a domain. In this scenario, the platform does not collect, regenerate, return, or display the Shared Secret value. The user manages it in the external identity domain, which must be a valid domain set up in the platform. The platform takes the Shared Secret value that the user provides and validates it with the external identity domain.

{
  "RuntimeID" : "80pQCDO3KJUYSWNfcxjcf4YI.acmepaymentscorp",
  "AppID" : "07eeda74-8681-4e4a-8e04-7d7229f8d4db.acmepaymentscorp",
  "Name" : "v1",
  "Description" : "Version 1.0",
  "Visibility" : "Public",
  "InitialEnvironment" : "Sandbox",
  "CurrentEnvironment" : "Sandbox",
  "Tag" : [ ],
  "HasKeyInfo" : false,
  "Created" : "2015-10-02T16:59:45.619Z",
  "Updated" : "2015-10-02T16:59:45.619Z",
  "State" : "com.soa.app.state.initial",
  "SecurityMechanisms" : [ "com.soa.security.mechanism.sharedsecret" ],
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "Identity" : "LdapAutomation1\\myuserid"
}

Back to top

 

Response Headers

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

Header Description
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
ApplicationVersion ApplicationVersion Information about the app version. The response includes settings if they were requested.

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
204 No content. The server successfully processed the request, but is not returning any content. For example, you might get this error if you specified an invalid AppVersionID.
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.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics