Get Access Rule Entity

Returns detailed info about Access Rule

Path Parameters

• rule-uid integer required

  Possible values: >= 1

  Unique Identifier for Access Rule Item

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• 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

{
  "name": "Fist two floors",
  "areas": [
    1000
  ],
  "item_uid": 3
}

{
  "item_uid": 1,
  "name": "Access Rule Name",
  "areas": [
    1000,
    1010,
    2000
  ]
}

Wrong access rule uid

application/json

• Schema
• Example (from schema)
• Wrong Access Rule uid

---

Schema

• error string

  Error message

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong access rule uid"
}

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...