Расписания

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

class schedules_api_crud_svc.ScheduleUpdateAttributes(*, cn: str = None, description: str | None = None, prsJsonConfigString: dict | None = None, prsActive: bool | None = None, prsDefault: bool | None = None, prsEntityTypeCode: int | None = None, prsIndex: int | None = None)

model_config: ClassVar[ConfigDict] = {'protected_namespaces': ()}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'cn': FieldInfo(annotation=str, required=False, title='Имя узла'), 'description': FieldInfo(annotation=Union[str, NoneType], required=False, title='Описание', description='Описание экземпляра.'), 'prsActive': FieldInfo(annotation=Union[bool, NoneType], required=False, title='Флаг активности'), 'prsDefault': FieldInfo(annotation=Union[bool, NoneType], required=False, title='Сущность по умолчанию.', description='Если = ``true``\\, то данный экземпляр считается узлом по умолчанию в списке равноправных узлов данного уровня иерархии.'), 'prsEntityTypeCode': FieldInfo(annotation=Union[int, NoneType], required=False, title='Тип узла.', description='Атрибут используется для определения типа. К примеру, хранилища данных могут быть разных типов.'), 'prsIndex': FieldInfo(annotation=Union[int, NoneType], required=False, title='Индекс узла.', description='Если у узлов одного уровня иерархии проставлены индексы, то перед отдачей клиенту списка экземпляров они сортируются в соответствии с их индексами.'), 'prsJsonConfigString': FieldInfo(annotation=Union[dict, NoneType], required=False, title='Конфигурация расписания')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

async schedules_api_crud_svc.create(payload: dict | None = None, error_handler: ErrorHandler = Depends(ErrorHandler))

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

Запрос:

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) - Определяет, активен ли экземпляр. Необязательный атрибут;

Ответ:

• id (uuid) - id созданного расписания

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