GET /api/apps/{AppID}

Returns information about 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/{AppID}[?][IncludeSettings={boolean}][&]{IncludeTags={boolean}]
[&]{IncludeIsFollowed={boolean}][&]{IncludeAvatarURL={boolean}]

Back to top

Sample Request

The example below requests information for the specified app.

Sample request URL #1

https://{hostname}/api/apps/4db49199-1de9-4bfc-9e8a-1960c1faa9f3.acmepaymentscorp

Sample request URL #2

https://{hostname}/api/apps/4db49199-1de9-4bfc-9e8a-1960c1faa9f3.acmepaymentscorp?IncludeSettings=true

Sample request headers

GET /api/apps/app16964.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
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/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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
AppID Path string Required The unique ID for a specific app.
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.
IncludeIsFollowed Query boolean Optional Indicates whether information on whether the resource is followed should be returned in the response. If not specified, defaults to true.
IncludeAvatarURL Query boolean Optional Indicates whether the avatar URL 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 information about the requested app. The information is returned as a JSON object.

Back to top

Sample Response

The sample response below is a response to the sample request above.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 27 Mar 2018 19:35:40 GMT

Sample response body #1

{
  "AppID":"4db49199-1de9-4bfc-9e8a-1960c1faa9f3.acmepaymentscorp",
  "Name":"Crosfhocal",
  "Description":"Crossword puzzle app for Android phones and iPhones",
  "Summary":"Crossword puzzle app",
  "Visibility":"Public",
  "DefaultVersionID":"tAWgWjHBj3Dh55j3lGAYTwdlfi2DbdG2zEgXCJYw.",",
  "IsFollowed":true,
  "RatingSummary":{
    "Five":0,
    "Four":0,
    "Three":0,
    "Two":0,
    "One":0
  },
  "State":"com.soa.app.state.active",
  "Created":"2018-03-27T19:13:21Z",
  "Updated":"2018-03-27T19:13:21Z",
  "AvatarURL":"http://acmepaymentscorpcloud.com/api/apps/avatar/_VqcagXNqhwqiKO4LLtdpGmQ",
  "BusinessID":"tenantbusiness.acmepaymentscorp",
  "TargetResources":{
    "TargetResource":[
      {
        "Name":"Tenant - acmepaymentscorp",
        "ID":"tenantbusiness.acmepaymentscorp",
        "Type":"business"
      }
    ]
  }
}

Sample response body #2

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

{
  "AppID":"c2f4fad5-850d-48eb-a9b7-82e3ccc33126.acmepaymentscorp",
  "Name":"Crosfhocal",
  "Description":"Crossword puzzle app",
  "Summary":"Crossword puzzle app",
  "Visibility":"Public",
  "DefaultVersionID":"w1jHSwRV1RvPeWs5NB2wUHNP6GKCvi78SsVbBQpb.acmepaymentscorp",
  "IsFollowed":true,
  "RatingSummary":{
    "Five":0,
    "Four":0,
    "Three":0,
    "Two":0,
    "One":0
  },
  "State":"com.soa.app.state.active",
  "Created":"2018-06-21T18:57:48Z",
  "Updated":"2018-06-21T22:04:34Z",
  "AvatarURL":"http://acmepaymentscorp.com/api/apps/avatar/_V_8TceffK_Nhbb1XJ5uumHg",
  "AppSettings":{
    "PublicAppSupport":"com.soa.feature.enabled",
    "PublicAppBoardSupport":"com.soa.feature.enabled",
    "PublicAppRatingsSupport":"com.soa.feature.enabled",
    "PublicAppReviewsSupport":"com.soa.feature.enabled",
    "PrivateAppSupport":"com.soa.feature.enabled",
    "PrivateAppBoardSupport":"com.soa.feature.enabled",
    "PrivateAppRatingsSupport":"com.soa.feature.enabled",
    "PrivateAppReviewsSupport":"com.soa.feature.enabled",
    "UserDefinedIdentitySupport":"com.soa.feature.enabled.for.siteadmins",
    "SimultaneousSandboxProductAccessSupport":"com.soa.feature.enabled",
    "ReturnPlainTextSharedSecret":"com.soa.feature.enabled",
    "RegisteredUsersAppSupport":"com.soa.feature.enabled",
    "RegisteredUsersAppRatingsSupport":"com.soa.feature.enabled",
    "RegisteredUsersAppReviewsSupport":"com.soa.feature.enabled",
    "AppPromotionSupport":"com.soa.feature.disabled"
  },
  "BusinessID":"tenantbusiness.acmepaymentscorp",
  "TargetResources":{
    "TargetResource":[
      {
        "Name":"Tenant - acmepaymentscorp",
        "ID":"tenantbusiness.acmepaymentscorp",
        "Type":"business"
      }
    ]
  }
}

Back to top

Response Headers

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

Header Description
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
Application Application Information about the app, including: AppID, Name, DefaultVersionID, IsFollowed, RatingSummary, State, Created, and Updated. 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
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.
404 The app could not be found. For example, you would get this if you included an incorrect AppID.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics