API Платформы Пересвет

Правила API

Предупреждение

Внимание! При создании любых сущностей (тэги, объекты, тревоги и т.д.) в их именах допустимы любые символы. При этом обратный слэш (\) и кавычки должны предваряться символом обратного слэша.

Есть несколько базовых правил, на которых основывается API платформы:

  1. Имена атрибутов в json-объектах, названия запросов придерживаются правил camelCase.

    Пример:

    {
   "parentId": "...",
   "tagName": "..."
}

  2. Тело запроса к платформе содержит только один json-объект. Массивы данных передаются внутри этого объекта.

  3. Ответ на запрос также содержит только один json-объект.

  4. В случае ошибки обработки запроса в json-объекте ответа на запрос есть ключ detail`, значение которого - список пояснений к ошибке:

    {
  "detail": [
      {
            "type": "type_of_error",
            "loc": [
               "place_of_error"
            ],
            "msg": "message",
            "input": {},
            "ctx": {
               "error": "name_of_error"
            }
      }
   ]
}

    либо строка:

    {
  "detail": "описание ошибки"
}

  5. По возможности все команды платформы работают с массивами данных. См. документацию на каждую команду.

  6. В связи с использованием ldap-сервера для хранения иерархий имена всех сущностей представлены в виде атрибута cn.

  7. У каждого узла в иерархии присутствует атрибут entryUUID. Это специальный неизменяемый атрибут, содержащий уникальный идентификатор узла. Платформа сама присваивает значение этому атрибуту при создании нового узла. При перемещении узла по иерархии этот атрибут сохраняется без изменений.

Модули