goalsmanagement.schema
Scope:
goalsmanagementКто может вызывать: Любой авторизованный пользователь REST. Подробнее: Права доступа
Возвращает машиночитаемую схему REST-методов goalsmanagement.* (параметры и ошибки по каталогу).
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| — | — | — | Нет параметров |
Возвращаемые данные
Ответ в конверте модуля: result.result — объект схемы; result.error.
Поля верхнего уровня схемы: scope, prefix, fetchAllMax, methods[] (method, http, params, errors, controller, action).
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.schema.json" \
-H "Accept: application/json"
Пример ответа
{
"result": {
"result": {
"scope": "goalsmanagement",
"prefix": "goalsmanagement.",
"fetchAllMax": 5000,
"methods": [
{
"method": "goalsmanagement.process.list",
"http": "GET",
"params": [
"limit",
"offset",
"fetchAll",
"filter"
],
"errors": [
"ACCESS_DENIED",
"INVALID_FILTER"
],
"controller": "Process",
"action": "list"
},
{
"method": "goalsmanagement.goalcard.create",
"http": "POST",
"params": [
"departmentId",
"employeeId"
],
"errors": [
"ACCESS_DENIED",
"VALIDATION_ERROR"
],
"controller": "GoalCard",
"action": "create"
}
]
},
"error": null
}
}
См. также
Предыдущая
Следующая