Ролевые приложения (roleapps)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/domain/roleapps

Создание нового ролевого приложения

GET

/rest/v1/domain/roleapps

Получение списка ролевых приложений

GET

/rest/v1/domain/roleapps/<id>

Получение данных ролевого приложения

PATCH

/rest/v1/domain/roleapps/<id>

Изменение данных ролевого приложения

DELETE

/rest/v1/domain/roleapps/<id>

Удаление ролевого приложения

LOOKUP

/rest/v1/domain/roleapps

Поиск идентификатора ролевого приложения

Создание нового ролевого приложения

Запрос

Описание полей: roleapp entity

Пример запроса
POST /rest/v1/domain/roleapps HTTP/1.1
Content-Type: application/json; charset=utf-8

roleapp entity

Ответ

Описание полей: roleapp entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "68f99ca9-016c-d352-e02f-50e54938780c",
  "title": "First app",
  "folder": "roleapp1",
  "archive": {
    "_links": {
      "self": {
        "href": "/rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment"
      }
    }
  },
  "roles": [
    "chatagent"
  ],
  "svcscriptcode": "chatagent_api",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-27T13:45:19.66Z",
    "lwt": "2019-08-27T13:45:19.66Z"
  }
}

Получение списка ролевых приложений

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, title, folder, archive, roles, svcscriptcode, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/domain/roleapps?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: roleapp entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "68f99ca9-016c-d352-e02f-50e54938780c",
    "title": "First app",
    "folder": "roleapp1",
    "archive": {
      "_links": {
        "self": {
          "href": "/rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment"
        }
      }
    },
    "roles": [
      "chatagent"
    ],
    "svcscriptcode": "chatagent_api",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T13:45:19.66Z",
      "lwt": "2019-08-27T13:45:19.66Z"
    }
  },
  {
    "id": "cdcfaf50-016c-d354-31d5-50e54938780c",
    "title": "Тестовое приложение",
    "folder": "roleapp2",
    "archive": {
      "_links": {
        "self": {
          "href": "/rest/v1/domain/roleapps/cdcfaf50-016c-d354-31d5-50e54938780c/attachment"
        }
      }
    },
    "roles": [
      "chatagent"
    ],
    "svcscriptcode": "",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T13:46:46.10Z",
      "lwt": "2019-08-27T13:46:46.10Z"
    }
  }
]

Получение данных ролевого приложения

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c HTTP/1.1

Ответ

Описание полей: roleapp entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "68f99ca9-016c-d352-e02f-50e54938780c",
  "title": "First app",
  "folder": "roleapp1",
  "archive": {
    "_links": {
      "self": {
        "href": "/rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment"
      }
    }
  },
  "roles": [
    "chatagent"
  ],
  "svcscriptcode": "chatagent_api",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-27T13:45:19.66Z",
    "lwt": "2019-08-27T13:45:19.66Z"
  }
}

Изменение данных ролевого приложения

Поля запрещенные для изменения: id

Запрос

Описание полей: roleapp entity

Пример запроса
PATCH /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

roleapp entity

Ответ

Описание полей: roleapp entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "68f99ca9-016c-d352-e02f-50e54938780c",
  "title": "АРМ оператора чат-центра",
  "folder": "roleapp1",
  "archive": {
    "_links": {
      "self": {
        "href": "/rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment"
      }
    }
  },
  "roles": [
    "chatagent"
  ],
  "svcscriptcode": "chatagent_api",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-27T13:45:19.66Z",
    "lwt": "2019-09-11T10:37:26.12Z"
  }
}

Удаление ролевого приложения

Запрос

Пример запроса
DELETE /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора ролевого приложения

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id

Запрос

Пример запроса
LOOKUP /rest/v1/domain/roleapps HTTP/1.1
Content-Type: application/json; charset=utf-8

"68f99ca9-016c-d352-e02f-50e54938780c"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "68f99ca9-016c-d352-e02f-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

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

Содержание (дочерние ресурсы)

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт