Create Access Rule

Creates Access Rule Entity.

Access rule provides access for proper areas when KONE lift adapter is used

application/json

Request Body required

• name string

  Access rule name

• areas int64[]

  List of areas

Responses

• 200
• 400
• 401
• 403

---

The uid value returned in the response can be used as the rule-uid parameter in next requests:

• GET/PATCH/DELETE /access/lift/rule/item/{rule-uid} - to read/update/delete access rule
• POST/DELETE /access/lift/rule/{rule-uid}/user/{user-uid} - to attach/detach access rule to user

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  Possible values: >= -1

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

{
  "uid": 3
}

{
  "uid": 3
}

• Wrong area: must be a digit
• Access rule with same areas already exists
• Missed json body or wrong param Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Wrong area
• Duplicate areas

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Wrong area: must be a digit"
}

{
  "error": "Access rule with same areas already exists: uid=1, name=Access Rule 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"
}

Loading...