GET v1/application/{environment}/{orgId}/{appId}/details
Use this method to get an application's details.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org originated from. |
string |
Required |
| orgId |
Organization Id |
integer |
Required |
| appId |
Application Id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the app model data if the app exists.
ApplicationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
Application name |
string |
None. |
| major |
Major version number (This is used for display purposes, should reflect the actual app version) |
integer |
None. |
| minor |
Minor version number (This is used for display purposes, should reflect the actual app version) |
integer |
None. |
| revision |
Revision number (This is used for display purposes, should reflect the actual app version) |
integer |
None. |
| build |
Build number (This is used for display purposes, should reflect the actual app version) |
integer |
None. |
| afPlatform |
App Framework Platform Simple Version the app references. |
decimal number |
None. |
| eula |
End user license agreement. |
string |
None. |
| maasId |
MaaS Application Identifier |
integer |
None. |
| orgId |
MaaS Org Identifier |
integer |
None. |
| appKey |
MaaS Application Key |
string |
None. |
| secretKey |
MaaS Application Secret Key |
string |
None. |
| supportedDevices |
Supported Device Type, when creating an app, the only value needed to be populated is the DeviceKind member of this class. Examples of valid device kind are: ios, iphone, ipad, android, blackberry, windowsphone, verizonfios, webbrowser. If you are creating a MaaS Application, the only device kind you will be using at the moment are: iphone, android |
Collection of DeviceType |
None. |
| hasLevels |
Optionally included via endpoints that allow for query levels. This field if present, will have true or false values depending on the app having nested content levels or not. |
boolean |
None. |
| id |
Entity unique identifier. |
UUID |
None. |
| type |
Type of entity this abstract class represents. |
EntityLinkType |
None. |
| parent |
Parent entity, i.e. if this was a property (Venue), the company that the property belongs to. |
Entity |
None. |
Response Formats
application/json, text/json
{
"name": "sample string 1",
"major": 2,
"minor": 3,
"revision": 4,
"build": 5,
"afPlatform": 7.1,
"eula": "sample string 8",
"maasId": 9,
"orgId": 10,
"appKey": "sample string 11",
"secretKey": "sample string 12",
"supportedDevices": [
{
"os": "sample string 1",
"deviceKind": "sample string 2",
"name": "sample string 3"
},
{
"os": "sample string 1",
"deviceKind": "sample string 2",
"name": "sample string 3"
}
],
"hasLevels": true,
"type": 1,
"parent": {
"type": 1
}
}
