goalsmanagement.goalitem.delete
Scope:
goalsmanagementКто может вызывать: Как goalsmanagement.goalitem.upsert: Права проверяются так же, как на странице карточки целей: участник карточки (сотрудник, руководитель, функциональный руководитель, директор, делегат) или администратор; процесс подразделения запущен; этап разрешает правку этой роли — «Черновик»: сотрудник, руководитель, делегат; «Согласование руководителем»: руководитель; «Функциональный руководитель»: функциональный руководитель; «Согласование директором»: директор; администратор — на любом этапе, кроме утверждённой карточки. Утверждённая карточка (
status_approval) только для просмотра, в том числе для администратора. С версии 16.0.1. Подробнее: Права доступаПодтверждение: без
confirm=true—CONFIRM_REQUIRED
Удалить цели карточки по ID (нужен confirm=true)
HTTP: POST
Побочные эффекты: удаление целей (каскад при confirm); вместе с целью удаляются значения её каталожных пользовательских полей
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
cardId |
int |
да | ID карточки |
goalIds |
array |
да | Массив ID целей |
confirm |
bool |
да | Явное подтверждение (true) |
Возвращаемые данные
Ответ в конверте модуля: result.result — результат удаления; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
VALIDATION_ERROR |
Некорректные или неполные параметры |
CONFIRM_REQUIRED |
Требуется явное подтверждение (confirm=true) |
ACCESS_DENIED |
Нет права править карточку на текущем этапе, или в goalIds есть цели другой карточки |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goalitem.delete.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{
"cardId": 501,
"goalIds": [
1001
],
"confirm": true
}'
Пример ответа
{
"result": {
"result": {
"cardId": 501,
"deletedIds": [
1001
]
},
"error": null
}
}