Методы

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

async methods_api_crud_svc.create(payload: MethodCreate, error_handler: ErrorHandler = Depends(ErrorHandler))

Метод добавляет метод в иерархию.

Запрос:

http

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

{
    "initiatedBy": "id of a node which initiates method",
    "attributes": {
        "prsMethodAddress":"method_adress",
        "prsEntityTypeCode":0,
        "cn":"method1",
        "description":"method1_description",
        "prsJsonConfigString":"method1_config_string",
        "prsActive":true
    },
    "parameters":[
        {
            "attributes":{
                "cn":"param1",
                "description":"param1_description",
                "prsJsonConfigString":"config_string1",
                "prsActive":true
            }
        },
        {
            "attributes":{
                "cn":"param2",
                "description":"param2_description",
                "prsJsonConfigString":"config_string2",
                "prsActive":true
            }
        }
    ],
    "parentId":"id of a node to which method adjasted"
}

response

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

{
    "id": "new method id"
}

  • parentId (str) - Id родительского узла. Обязательное поле.

  • initiatedBy (str | list[str]) - Список id экземпляров сущностей, инициирующих вычисление тега. Необязательный атрибут.

  • attributes (dict) - Атрибуты метода. Обязательное поле. Включает в себя:

    • prsMethodAddress (str) - Адрес метода. Обязательное поле.

    • prsEntityTypeCode (int) - Тип метода. Необязательное поле.

  • parameters (List[MethodParameter]) - Параметры метода. Необязательное поле.

    • MethodParameter - Включает в себя:

      • attributes (dict) - Атрибуты узла. Необязательное поле.

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

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

        • prsJsonConfigString (str) - Строка содержит, в случае необходимости,

          конфигурацию узла. Интерпретируется сервисом, управляющим сущностью, которой принадлежит экземпляр. Необязательный аттрибут

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

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

          считаеться узлом по умолчанию в списке равноправных узлов данного уровня иерархии. Необязательный атрибут.

        • prsIndex (int) - Если у узлов одного уровня иерархии проставлены индексы, то

          перед отдачей клиенту списка экземпляров они сортируются соответственно их индексам. Необязательный атрибут.

Ответ:

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

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