Расписания

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

async schedules_api_crud_svc.create(payload: ScheduleCreate)

Метод добавляет расписание в иерархию.

Запрос:

http

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

{
    "attributes":{
        "cn":"schedule3",
        "prsJsonConfigString":"{\"start\":\"2024-07-07\",\"end\":\"2025-07-07\",\"interval_type\":\"seconds\",\"interval_value\":4}",
        "description":"schedule description",
        "prsActive":true
    }
}

response

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

{
    "id": "идентификатор_созданного_расписания"
}

• attributes (dict) - словарь с параметрами для создания расписания.

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

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

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

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

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

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

  • prsArchive (bool) - Флаг архивирования начений тега. Необязательный аттрибут

  • prsCompress (bool) - Флаг сжатия значений тега. Необязательный атрибут; Если не указан, то поиск ведётся от главного узла иерархии. Необязательный атрибут;

  • prsMaxLineDev (float) - Параметр сжатия значений тега. Необязательный атрибут;

  • prsStep (bool) - Флаг ступенчатого тега. Необязательный атрибут;

  • prsUpdate (bool) - Флаг обновления значений тега. Необязательный атрибут;

  • prsValueTypeCode (int) - Тип значений тега. Необязательный атрибут;

  • prsDefaultValue (Any) - Значение тега по умолчанию. Необязательный атрибут;

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

Ответ:

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

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