Хранилища данных

Модуль содержит примеры запросов и ответов на них, параметров которые могут входить в запрос, в сервисе dataStorages.

async dataStorages_api_crud_svc.create(payload: DataStorageCreate, error_handler: ErrorHandler = Depends(ErrorHandler))

Метод добавляет Хранилище данных в иерархию.

Запрос:

http

POST /v1/dataStorages/ HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json
Authorization: No Auth

{
    "linkTags":[{
        "tagId":"<link_tag_id>",
        "attributes":{
            "cn":"tag1",
            "objectClass":"prsTag"
        }
    }],
    "linkAlerts":[{
        "alertId":"<link_alert_id>",
        "attributes":{
            "cn":"alert1",
            "objectClass":"prsAlert"
        }
    }],
    "attributes":{
        "prsJsonConfigString":"{\"dsn\":\"postgresql://postgres:Peresvet21@psql/peresvet\"}",
        "cn": "dataStorage_test",
        "description": "test_DS"
    }
}

response

HTTP/1.1 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Content-type: application/json

{
    "id": "<id_of_created_dataStorage>"
}

• linkTags (list[LinkTag]) - Список привязываемых тегов.

  • LinkTag - Привязываемый тег. Включает в себя:

    • tagId (str) - идентификатор привязываемого тега. Обязательный атрибут.

    • attributes - список параметров привязываемого тега.

      • cn (str) - Имя привязки. Обязательный атрибут.

      • prsStore (dict) - Хранилище тега. Необязательный атрибут.

      • objectClass (str) - Класс узла. Обязательный атрибут.

• linkAlerts (list[LinkAlert]) - Список привязываемых тревог

  • LinkAlert - Привязываемая тревога. Включает в себя:

    • alertId (str) - Идентификатор привязываемой тревоги. Обязательный атрибут.

    • attributes - список параметров привязываемой тревоги. Включает в себя:

      • cn (str) - Имя привязки. Обязательный атрибут.

      • prsStore (dict) - Хранилище тревоги. Необязательный атрибут.

      • objectClass (str) - Класс узла. Обязательный атрибут.

• attributes (dict) - Атрибуты хранилища

  • cn (str) - имя хранилища. Необязательный атрибут.

  • description (str) - описание хранилища. Необязательный атрибут.

  • prsJsonConfigString (str) - Строка содержит, в случае необходимости, конфигурацию узла. Интерпретируется сервисом, управляющим сущностью, которой принадлежит экземпляр. Необязательный аттрибут

  • prsActive (bool) - Определяет, активно ли хранилище. Необязательный атрибут.

  • prsDefault (bool) - Если = True, то данный экземпляр. Необязательный атрибут. считается узлом по умолчанию в списке равноправных узлов данного уровня иерархии. Необязательный атрибут.

  • prsIndex (int) - Если у узлов одного уровня иерархии проставлены индексы, то перед отдачей клиенту списка экземпляров они сортируются в соответствии с их индексами. Необязательный атрибут.

Ответ:

• id (uuid) - id созданного тега

• detail (str) - пояснения к ошибке