Representation rules (representatives)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new representation rule
Request
Field description: representative entity
POST /rest/v1/uc/representatives HTTP/1.1
Content-Type: application/json; charset=utf-8
representative entity
Response
Field description: representative entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
"priority": 76,
"dir": "cross",
"ofdomain": "$.rootdomain.ru",
"ofnumber": "XXX",
"ofusername": "",
"fordomain": "",
"fornumber": "",
"forusername": "",
"action": "apply",
"modifier": "5T",
"moddisplay": "*",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-28T07:54:09.62Z",
"lwt": "2019-08-28T07:54:09.62Z"
}
}
Getting the list of representation rules
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: id, priority, dir, ofdomain, ofusername, ofnumber, fordomain, forusername, fornumber, action, modifier, opts.title, 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/uc/representatives?offset=0&limit=2 HTTP/1.1
Response
Field description: representative entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "4f3fc6d5-016c-d738-96f2-50e54938780c",
"priority": 75,
"dir": "inner",
"ofdomain": "",
"ofnumber": "XXX",
"ofusername": "",
"fordomain": "$.rootdomain.ru",
"fornumber": "",
"forusername": "",
"action": "apply",
"modifier": "7XXX",
"moddisplay": "",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-28T07:55:05.84Z",
"lwt": "2019-08-28T07:55:05.84Z"
}
},
{
"id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
"priority": 76,
"dir": "cross",
"ofdomain": "$.rootdomain.ru",
"ofnumber": "XXX",
"ofusername": "",
"fordomain": "",
"fornumber": "",
"forusername": "",
"action": "apply",
"modifier": "5T",
"moddisplay": "",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-28T07:54:09.62Z",
"lwt": "2019-08-28T07:54:09.62Z"
}
}
]
Getting representation rule data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/representatives/9b64ae6e-016c-d737-bb5c-50e54938780c HTTP/1.1
Response
Field description: representative entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
"priority": 76,
"dir": "cross",
"ofdomain": "$.rootdomain.ru",
"ofnumber": "XXX",
"ofusername": "",
"fordomain": "",
"fornumber": "",
"forusername": "",
"action": "apply",
"modifier": "5T",
"moddisplay": "*",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-28T07:54:09.62Z",
"lwt": "2019-08-28T07:54:09.62Z"
}
}
Modifying representation rule data
Fields prohibited for modification: id
Request
Field description: representative entity
PATCH /rest/v1/uc/representatives/9b64ae6e-016c-d737-bb5c-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8
representative entity
Response
Field description: representative entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
"priority": 77,
"dir": "cross",
"ofdomain": "test.rootdomain.ru",
"ofnumber": "XXX",
"ofusername": "",
"fordomain": "",
"fornumber": "",
"forusername": "",
"action": "apply",
"modifier": "35T",
"moddisplay": "*",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-28T07:54:09.62Z",
"lwt": "2019-09-09T08:56:14.39Z"
}
}
Deleting a representation rule
Searching for a representation rule identifier
Searches for a resource by the specified key and returns the identifier(s) for building the endpoint.
Key fields for search: id