Subordination rules (subordinations)

Requests

HTTP verb Endpoint Description

POST

/rest/v1/domain/subordinations

Creating a new subordination rule

GET

/rest/v1/domain/subordinations

Getting the list of subordination rules

GET

/rest/v1/domain/subordinations/<id>

Getting subordination rule data

PATCH

/rest/v1/domain/subordinations/<id>

Modifying subordination rule data

DELETE

/rest/v1/domain/subordinations/<id>

Deleting a subordination rule

LOOKUP

/rest/v1/domain/subordinations

Searching for a subordination rule identifier


Creating a new subordination rule

Request

Field description: subordination entity

Example request
POST /rest/v1/domain/subordinations HTTP/1.1
Content-Type: application/json; charset=utf-8

subordination entity

Response

Field description: subordination entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "user",
  "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Getting the list of subordination rules

Request

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: id, top_type, top_key, sub_type, sub_keys, opts.title, opts.comment, ext.lwt, ext.ct.

offset

int

Offset in the list of resources to output.

limit

int

Maximum number of resources in the list.

order

array<object|str>

Sorting order of resources in the list.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/subordinations?offset=0&limit=2 HTTP/1.1

Response

Field description: subordination entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
    "top_type": "user",
    "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
    "sub_type": "user",
    "sub_keys": [
      "00000002-abcd-abcd-abcd-abcdabcdabcd",
      "00000003-abcd-abcd-abcd-abcdabcdabcd"
    ],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2022-10-20T13:37:03.82Z",
      "lwt": "2022-10-20T13:41:42.25Z"
    }
  },
  {
    "id": "abcdef00-05b7-8163-948c-3392a9660db9",
    "top_type": "role",
    "top_key": "callcenter_supervisor",
    "sub_type": "group",
    "sub_keys": [
      "315f0002-1234-abcd-abcd-abcdabcdabcd",
      "6e003b59-2345-abcd-abcd-abcdabcdabcd"
    ],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2022-10-20T12:22:25.26Z",
      "lwt": "2022-10-20T12:22:25.26Z"
    }
  }
]

Getting subordination rule data

Request

Table 2. Request parameters
Name Type Description

mask

str

List of fields to output.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/groups/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Response

Field description: subordination entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "user",
  "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Modifying subordination rule data

Fields prohibited for modification: id

Request

Field description: subordination entity

Example request
PATCH /rest/v1/domain/groups/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1
Content-Type: application/json; charset=utf-8

subordination entity

Response

Field description: subordination entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "role",
  "top_key": "admin",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Deleting a subordination rule

Request

Example request
DELETE /rest/v1/domain/subordinations/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Response

Example response
HTTP/1.1 204 No Content

Searching for a subordination rule identifier

Searches for a resource by the specified key and returns the identifier(s) for building the endpoint.

Key fields for search: id

Request

Example request
LOOKUP /rest/v1/domain/subordinations HTTP/1.1
Content-Type: application/json; charset=utf-8

"afafafaf-0178-3fc1-67fc-7cd30a921f58"

Response

Example successful response
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "afafafaf-0178-3fc1-67fc-7cd30a921f58"
]
Example failed response
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}