helpdesk.category.add
Scope:
helpdeskКто может вызывать: Admin портала или admin техподдержки.
Создать категорию (CTicketDictionary::Add, C_TYPE=C)
HTTP: POST
Побочные эффекты: создаёт запись словаря категорий
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
name / NAME |
string |
да | Название |
sid / SID |
string |
нет | Символьный код |
sort / cSort / C_SORT |
int |
нет | Сортировка (default 100) |
description / descr / DESCR |
string |
нет | Описание |
responsibleId / RESPONSIBLE_USER_ID |
int |
нет | Ответственный по умолчанию |
isDefault / SET_AS_DEFAULT |
bool / Y/N |
нет | Категория по умолчанию |
siteId / FIRST_SITE_ID |
string |
нет | Один LID сайта → пишется в FIRST_SITE_ID и arrSITE = [siteId] |
sites / siteIds / arrSITE |
string | string[] |
нет | Один сайт или список LID. Строка трактуется как массив из одного элемента. Задаёт arrSITE; первый элемент → FIRST_SITE_ID |
event1, event2, event3 |
string |
нет | События статистики |
Если переданы и массив (sites / siteIds / arrSITE), и siteId — приоритет у массива (pickSites). siteId учитывается только когда массив-алиасы не переданы.
Примеры привязки к сайтам
{ "name": "Категория", "siteId": "s1" }
{ "name": "Категория", "sites": ["s1", "s2"] }
{ "name": "Категория", "sites": "s1" }
Возвращаемые данные
Ответ: созданная категория как category.get — есть и siteId (строка, FIRST_SITE_ID), и sites (массив LID).
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
PERMISSION_DENIED |
Не admin |
VALIDATION_ERROR |
Пустое имя или ошибка сохранения |
INTERNAL |
Внутренняя ошибка |
Пример запроса (POST)
curl -X POST "https://76575.dev.wehive.digital/rest/1/lus1tijk9ll7mg7h/helpdesk.category.add.json" -H "Content-Type: application/json" --data '{"name":"Новая категория","sid":"new_cat","sort":100,"sites":["s1"]}'
Пример ответа
{
"result": {
"result": {
"id": 49,
"name": "Новая категория",
"sid": "new_cat",
"type": "C",
"siteId": "s1",
"sites": ["s1"]
},
"error": null
}
}
См. также
Предыдущая
Следующая