ipr.schema

Scope: ipr

Кто может вызывать: Любой авторизованный пользователь REST. Подробнее: Роли и права доступа

Возвращает машиночитаемую JSON-схему всех методов ipr.*: конверт ответа, параметры пагинации, операторы фильтра и список методов с их (эвристически определёнными) HTTP-методом и параметрами. Предназначен в первую очередь для AI-агентов и автогенерации клиентов.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
— — — Нет параметров

Возвращаемые данные

Поле Описание
version Версия схемы ("1.0")
module "ithive.ipr"
scope "ipr"
envelope Список полей конверта ответа: ["result", "total", "next", "error"]
pagination { limit: { default, max }, offset: { default }, fetchAll: { default, maxRows } }
filterOperators Список поддерживаемых операторов фильтра
methods Массив { method, http, description, params } по каждому зарегистрированному методу

Поле methods[].description в текущей версии схемы не заполняется (пустая строка); http и params — эвристика по имени метода, для точных данных используйте страницы конкретных методов в этом справочнике.

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.schema.json"
          -H "Accept: application/json"

Пример ответа

{
          "result": {
            "result": {
              "version": "1.0",
              "module": "ithive.ipr",
              "scope": "ipr",
              "envelope": ["result", "total", "next", "error"],
              "pagination": {
                "limit": { "default": 50, "max": 500 },
                "offset": { "default": 0 },
                "fetchAll": { "default": false, "maxRows": 5000 }
              },
              "filterOperators": ["$eq", "$ne", "$gt", "$gte", "$lt", "$lte", "$in", "$nin"],
              "methods": [
                {
                  "method": "ipr.ipr.add",
                  "http": "POST",
                  "description": "",
                  "params": [
                    { "name": "userId", "type": "int", "required": true },
                    { "name": "managerId", "type": "int", "required": true, "description": "Must differ from userId" },
                    { "name": "competenceIds", "type": "array", "required": true, "description": "Catalog competence ids (≥1)" }
                  ]
                }
              ]
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.currentUser
Следующая
Обзор раздела