Subordination rules (subordinations)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new subordination rule
Request
Field description: subordination entity
POST /rest/v1/domain/subordinations HTTP/1.1
Content-Type: application/json; charset=utf-8
subordination entity
Response
Field description: subordination entity
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
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
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 in the list of resources to output. |
|
|
Maximum number of resources in the list. |
|
|
Sorting order of resources in the list. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/domain/subordinations?offset=0&limit=2 HTTP/1.1
Response
Field description: subordination entity
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
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/domain/groups/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1
Response
Field description: subordination entity
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
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
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
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