Get All Access Rules

Returns detailed info about all Access Rule

Query Parameters

• limit integer

  Possible values: [10, 20, 30, 50]

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

• sort_field string

  Field name (JSON Key in item entity)

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options for Apartment

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_items object[]

  Access rule

  name string

  Access rule name

  areas int64[]

  List of areas

  item_uid integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

• list_option object

  Available options for sorting, filtering and pagination of lists

  pagination object

  Available pagination options for tables

  total_items integer

  The total number of items found and reflected across all pages

  items_limit integer

  Possible values: [10, 20, 30, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  filter object

  Available filter sets for KONE access rules

  anyOf

  • MOD1
  • MOD2

  ---

  filter_field string

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filtering type, only equal here

  filter_format string

  Data format, only string here

  filter_value string

  Filter value

  filter_field string

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filtering type, only equal here

  filter_format string

  Data format, number here

  filter_value string

  Item unique id

  sort object

  Available sorting options for the selected table

  field string

  Sorting field name

  asc boolean

  Sort direction

  available_fields undefined[]

  Possible values: [item_uid, name]

  Available for sorting fields names

{
  "list_items": [
    {
      "name": "Fist two floors",
      "areas": [
        1000
      ],
      "item_uid": 3
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "BAS-IP"
    },
    "sort": {
      "field": "item_uid",
      "asc": true,
      "available_fields": [
        "item_uid"
      ]
    }
  }
}

{
  "list_items": [
    {
      "item_uid": 1,
      "name": "First two floors",
      "areas": [
        1000,
        2000
      ]
    },
    {
      "item_uid": 2,
      "name": "First three floors",
      "areas": [
        1000,
        2000,
        3000
      ]
    }
  ],
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "First",
      "available_filtering": true,
      "available_fields": [
        "item_uid",
        "name"
      ],
      "is_filtered": true
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "item_uid",
        "name"
      ]
    }
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

This feature is disabled on your device

Loading...