GET v1/application/{environment}/{orgId}?queryLevels={queryLevels}

Returns all applications associated with an org.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
environment

Environment where the org id was created from.

 string

Required
orgId

MaaS Org Id.

 integer

Required
queryLevels

(Optional) Set to true in order to query if any of the applications returned have nested content levels. This is a convenience option, please note that this is an expensive operation and should be used only, if you intend to drive logic based on the fact that an application has or not nested levels. When set to true, the payload will include a field named "hasLevels" with true, or false to indicate if they do. When this parameter is omitted, or set to false, the payload will not contain this field.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ApplicationModel
NameDescriptionTypeAdditional 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

Sample: 
[
  {
    "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
    }
  },
  {
    "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
    }
  }
]