GET v1/layers/{environment}/{orgId}/{appId}?pageIndex={pageIndex}&pageSize={pageSize}&sort={sort}&includeDisabled={includeDisabled}

Use this method to retrieve all levels associated to an application. To obtain the complete list of level associated to an application without paging, ignore the pageSize parameter, or set it to -1. When Page Size is set to -1 or not present, parameter page index is ignored altogether.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
environment

MaaS Environment where org and app ids are found.

 string

Required
orgId

MaaS Organization unique identifier.

 integer

Required
appId

MaaS App Id

 integer

Required
pageIndex

Optional parameter greater or equal to zero that specifies the page index if paging is desired. Defaults to 0.

 integer

Default value is 0
pageSize

Optional parameter that specifies how many items per page to return. Default value is -1, for this Endpoint this value means all levels.

 integer

Default value is -1
sort

Optional parameter used to specify the direction of the result order. This can be ascending, or descending, Default value is ascending.

 SortOption

Default value is Default
includeDisabled

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Returns a list of levels (properties) associated to an application.

Collection of Property
NameDescriptionTypeAdditional information
name

Name of the property or venue.

 string

None.
settings

This property will be updated and retrieved in separate calls

 Collection of Setting

None.
enabled

This fields allows you to see if a property is enabled / disabled

 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",
    "settings": [
      {
        "systemId": "sample string 1",
        "group": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4",
        "value": "sample string 5"
      },
      {
        "systemId": "sample string 1",
        "group": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4",
        "value": "sample string 5"
      }
    ],
    "enabled": true,
    "type": 1,
    "parent": {
      "type": 1
    }
  },
  {
    "name": "sample string 1",
    "settings": [
      {
        "systemId": "sample string 1",
        "group": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4",
        "value": "sample string 5"
      },
      {
        "systemId": "sample string 1",
        "group": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4",
        "value": "sample string 5"
      }
    ],
    "enabled": true,
    "type": 1,
    "parent": {
      "type": 1
    }
  }
]