Схемы запросов и ответов
Справочник полей публичных моделей запросов и ответов DCC V2. Поля унаследованных моделей включены в таблицы. Обязательность означает наличие ключа; допустимость null определяется типом. Межполевые правила и валидаторы дополнительно проверяются сервером; окончательный контракт — OpenAPI вашей инсталляции.
AddLogsRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
logs | List[TaskLogCreateRequest] | Да | — | Список логов | min_length=1 |
AddLogsResult
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
status | str | Нет | 'ok' | ||
count | int | Да | — | Записей в пакете | |
inserted | int | Да | — | Сохранено впервые (повторы message_id не дублируются) | |
message_ids | List[str] | Да | — | Подтверждённые message_id пакета |
AddQueueData
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_project | str | Да | — | ID проекта | |
id_line | int | Да | — | Номер строки/позиции в очереди | |
delete_mode | QueueDeleteMode | Да | — | Режим удаления: always/successful/never | |
operation | QueueOperation | Да | — | Операция: insert/update/delete | |
comment | Optional[str] | Нет | None | Комментарий | |
timestamp | Optional[int] | Нет | None | Unix-время (мс) | |
user | Optional[str] | Нет | None | Пользователь | |
params | Optional[Dict[str, Any]] | Нет | None | Параметры (значение: строка / {type, value} / массив) | |
params_ext | Optional[Dict[str, Any]] | Нет | None | Доп. параметры (см. data.params) | |
params_ini | Optional[Dict[str, Any]] | Нет | None | Исходные параметры (см. data.params) | |
params_string | Optional[str] | Нет | None | Строковое представление параметров |
AddQueueTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.ADD_QUEUE] | Нет | CommandType.ADD_QUEUE | ||
data | AddQueueData | Да | — | Параметры очереди |
ApiError
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
code | str | Да | — | Машиночитаемый код ошибки, напр. PROJECT_NOT_FOUND | |
message | str | Да | — | Человекочитаемое сообщение | |
details | Optional[Dict[str, Any]] | Нет | None | Доп. детали |
ApiResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
success | bool | Нет | True | ||
data | Optional[T] | Нет | None | ||
error | Optional[ApiError] | Нет | None | ||
meta | Optional[Meta] | Нет | None |
CommonResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
message | str | Да | — |
ConfigurationMetadataObjectResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ID коннектора | |
type | ConfigurationMetadataType | Да | — | Тип метаданных | |
entity_id | str | Да | — | Идентификатор объекта внутри типа | |
object | Dict[str, Any] | Да | — | Структура объекта: поля, типы, длины, обязательность, связи |
ConfigurationMetadataReadResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ID коннектора | |
data | Dict[ConfigurationMetadataType, Dict[str, Any]] | Да | — | Метаданные конфигурации 1C, ключ — тип метаданных |
ConfigurationMetadataTypeResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ID коннектора | |
type | ConfigurationMetadataType | Да | — | Тип метаданных | |
last_version | int | None | Нет | None | Последняя версия | |
data | Dict[str, Any] | None | Нет | None | Данные последней версии | |
diff | Dict[str, Any] | None | Нет | None | Diff последней версии |
ConfigurationMetadataUpdateResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ID коннектора | |
data | Dict[ConfigurationMetadataType, Dict[str, Any]] | Да | — | Метаданные конфигурации 1C, ключ — тип метаданных | |
failed_types | Dict[ConfigurationMetadataType, str] | Нет | {} | Типы метаданных, которые не удалось обновить (не существуют) |
ConfigurationMetadataUpsertRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
data | Dict[ConfigurationMetadataType, Dict[str, Any]] | Да | — | Метаданные конфигурации 1C: ключ — тип метаданных, значение — данные сущности |
ConnectionCheckResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | str | Да | — | ||
connected | bool | Да | — | ||
message | str | None | Нет | None | ||
exception | str | None | Нет | None |
ConnectorCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
client_contract | Optional[str] | Нет | None | Контракт клиента, напр. extractor-1c/2.0 | |
supported_commands | Optional[List[str]] | Нет | None | Команды, которые клиент умеет исполнять (типы задач + cancel). DCC не ставит на доставку остальные (409 UNSUPPORTED_CONNECTOR_COMMAND). null — не объявлено (коннектор получает всё, как раньше). | |
type | str | Да | — | Тип: 1c (также Extractor1C), sap, generic | |
name | str | Да | — | min_length=1, max_length=100 | |
group_name | Optional[str] | Нет | None | ||
user_name | str | Да | — | ||
timestamp | Optional[datetime] | Нет | None | ||
data | Optional[Dict[str, Any]] | Нет | {} | ||
info | Optional[str] | Нет | None | ||
base_url | Optional[HttpUrlStr] | Нет | None | Адрес коннектора для прямой проверки /health. http(s)://host:port | |
last_status | Optional[str] | Нет | None | ||
last_status_dt | Optional[datetime] | Нет | None | ||
previous_status | Optional[str] | Нет | None | ||
previous_status_dt | Optional[datetime] | Нет | None | ||
ecc_dt | Optional[datetime] | Нет | None | ||
is_deleted | bool | Нет | False | ||
id_connector | Optional[UUID] | Нет | None |
ConnectorHealthResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ||
available | bool | Да | — | Коннектор ответил на прямую пробу | |
status | str | Да | — | up | down | unknown | |
checked_at | datetime | Да | — | Время выполнения пробы | |
response_time_ms | Optional[int] | Нет | None | Латентность ответа коннектора, мс | |
source | str | Да | — | probe (живая проба) | cache (из кэша TTL) | no_address (base_url не задан) | |
lifecycle_status | Optional[str] | Нет | None | Справочно: админ-статус жизненного цикла коннектора | |
detail | Optional[Dict[str, Any]] | Нет | None | Полезная нагрузка ответа коннектора или причина недоступности |
ConnectorResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | UUID | Да | — | ||
type | str | Да | — | ||
name | str | Да | — | ||
group_name | Optional[str] | Да | — | ||
user_name | Optional[str] | Да | — | ||
timestamp | datetime | Да | — | ||
data | Dict[str, Any] | Нет | {} | ||
info | Optional[str] | Да | — | ||
last_status | str | Да | — | ||
last_status_dt | datetime | Да | — | ||
previous_status | Optional[str] | Да | — | ||
previous_status_dt | Optional[datetime] | Да | — | ||
ecc_dt | datetime | Да | — | ||
is_deleted | bool | Да | — | ||
base_url | Optional[str] | Нет | None | ||
last_health_status | Optional[str] | Нет | None | Последний heartbeat: up — коннектор сам опрашивал tasks/pending; null — контакта не было | |
last_health_at | Optional[datetime] | Нет | None | Время последнего heartbeat (исходящего опроса tasks/pending коннектором) | |
client_contract | Optional[str] | Нет | None | Объявленный контракт клиента | |
supported_commands | Optional[List[str]] | Нет | None | Объявленные клиентом команды (null — не объявлял) |
ConnectorUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
client_contract | Optional[str] | Нет | None | Контракт клиента, напр. extractor-1c/2.0 | |
supported_commands | Optional[List[str]] | Нет | None | Команды, которые клиент умеет исполнять (типы задач + cancel). DCC не ставит на доставку остальные (409 UNSUPPORTED_CONNECTOR_COMMAND). null — не объявлено (коннектор получает всё, как раньше). | |
name | Optional[str] | Нет | None | min_length=1, max_length=100 | |
group_name | Optional[str] | Нет | None | ||
user_name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | Тип: 1c, sap, generic | |
info | Optional[str] | Нет | None | ||
data | Optional[Dict[str, Any]] | Нет | None | ||
base_url | Optional[HttpUrlStr] | Нет | None | Адрес коннектора для прямой проверки /health. http(s)://host:port |
ConnectorUpdateStatusRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
status | str | Да | — | active, suspended, deleted | |
reason | Optional[str] | Нет | None |
ErrorResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
detail | str | Да | — | ||
code | Optional[str] | Нет | None |
ExecRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
mode | ExecMode | Нет | ExecMode.ASYNC | sync — ждать результат, async — вернуть task_id | |
timeout | int | Нет | 60 | Таймаут ожидания для sync, сек | ge=1, le=600 |
data | Optional[Dict[str, Any]] | Нет | None | Параметры запуска | |
source | Optional[str] | Нет | None | Источник запуска (напр. mover) |
ExecTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.EXEC] | Нет | CommandType.EXEC | ||
data | Optional[Dict[str, Any]] | Нет | None | Опционально; в доке exec передаётся без data |
ExtractorConnectionExport
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
source_connector_id | str | Да | — | ||
target_connector_id | str | Да | — | ||
id_db_connection | str | Да | — | ||
type | str | Да | — | ||
name | str | Да | — | ||
connection_properties | dict[str, Any] | Да | — |
ExtractorConnectionExportRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
target_connector_id | str | Да | — | Коннектор, в который переносится подключение |
ExtractorConnectionPut
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | Optional[str] | Нет | None | Если передан — обязан совпадать с путём | |
id_db_connection | Optional[str] | Нет | None | Если передан — обязан совпадать с путём | |
type | str | Да | — | Внешний тип (custom — фактический тип в connection_properties.type) | |
name | str | Да | — | ||
is_active | Optional[bool] | Нет | None | ||
is_deleted | Optional[bool] | Нет | False | ||
connection_properties | dict[str, Any] | Да | — | Свойства в формате Экстрактора | |
message_id | Optional[str] | Нет | None | ID исходящего сообщения 1С (для трассировки) |
ExtractorConnectionView
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | str | Да | — | ID записи в DCC (для /v2/db-connections/{id}) | |
id_connector | str | Да | — | ||
id_db_connection | str | Да | — | ||
type | str | Да | — | ||
name | str | Да | — | ||
is_active | Optional[bool] | Нет | None | ||
is_deleted | bool | Да | — | ||
connection_properties | dict[str, Any] | Да | — | Без секретов и полей <...>Зашифровано | |
protected_fields | List[str] | Да | — | Имена скрытых защищённых реквизитов |
ExtractorInstallTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.EXTRACTOR_INSTALL] | Нет | CommandType.EXTRACTOR_INSTALL | ||
data | Optional[Dict[str, Any]] | Нет | {} | Свободный payload (спецификация не определена) |
FieldItem
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | str | Да | — | ||
type | str | Да | — | Типы одной строкой (как в describe MCP) | |
kind | str | Да | — | standard | attribute | dimension | resource | derived | |
metadataTargets | List[str] | Да | — | ||
types | List[Dict[str, Any]] | Да | — | Все альтернативы составного типа с квалификаторами | |
synonym | Optional[str] | Нет | None | ||
origin | str | Да | — | snapshot — поле из снимка 1С; derived — выведено правилом | |
typeKnown | bool | Да | — | ||
basis | Optional[str] | Нет | None | ||
warnings | List[str] | Нет | [] |
FieldsPage
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок | |
object | str | Да | — | ||
resolvedObject | str | Да | — | Объект, чьи поля отданы (для виртуальной таблицы — регистр) | |
virtualTable | Optional[str] | Нет | None | ||
items | List[FieldItem] | Да | — | ||
total | int | Да | — | ||
nextCursor | Optional[int] | Нет | None | ||
metadataEnriched | bool | Да | — | false — у части полей тип неизвестен или это приближение | |
objectWarnings | List[str] | Нет | [] |
InitialProjectTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.INITIAL_PROJECT] | Нет | CommandType.INITIAL_PROJECT | ||
data | Optional[Dict[str, Any]] | Нет | None | Опционально; в доке initial_project передаётся без data |
IntegrationCapabilitiesResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
contracts | List[str] | Да | — | Поддерживаемые сервером контракты интеграции | |
command_types | List[str] | Да | — | Типы команд, которые сервер умеет создавать и доставлять | |
max_batch_size | int | Да | — | Максимум записей в одном пакете логов | |
max_request_bytes | int | Да | — | Максимальный размер тела запроса /v2 (иначе 413) | |
pending_page_max | int | Да | — | Максимум задач в одной выдаче /tasks/pending | |
idempotency_retention_seconds | int | Да | — | Сколько хранится ответ по Idempotency-Key | |
token_expires_in | int | Да | — | Срок жизни access_token, сек | |
mcp_max_payload_bytes | int | Да | — | Максимум байт UTF-8 в payload MCP-операции (иначе 413) | |
mcp_max_result_bytes | int | Да | — | Максимум байт UTF-8 в результате MCP-операции (иначе 413) | |
mcp_result_retention_seconds | int | Да | — | Срок хранения MCP-операции и результата, сек |
LoadTemplateData
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
target | Optional[LoadTemplateTarget] | Нет | None | Назначение импорта | |
source | LoadTemplateSource | Да | — | Источник шаблона |
LoadTemplateSource
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
db_connection | Optional[LoadTemplateSourceDbConnection] | Нет | None | Ссылка на подключение-источник | |
project | Optional[LoadTemplateSourceProject] | Нет | None | Ссылка на проект-источник |
LoadTemplateSourceDbConnection
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | Optional[str] | Нет | None | ID коннектора базы-источника | |
id_db_connection | Optional[str] | Нет | None | ID подключения в базе-источнике |
LoadTemplateSourceProject
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | Optional[str] | Нет | None | ID коннектора базы-источника | |
id_project | Optional[str] | Нет | None | ID проекта в базе-источнике |
LoadTemplateTarget
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_project | Optional[str] | Нет | None | ID проекта в базе-получателе | |
id_db_connection | Optional[str] | Нет | None | ID подключения в базе-получателе | |
db_connection_name | Optional[str] | Нет | None | Новое имя импортируемого подключения | |
project_name | Optional[str] | Нет | None | Новое имя проекта после импорта |
LoadTemplateTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.LOAD_TEMPLATE] | Нет | CommandType.LOAD_TEMPLATE | ||
data | LoadTemplateData | Да | — | Параметры загрузки шаблона |
LogsPageResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
count | int | Да | — | ||
limit | int | Да | — | ||
offset | int | Да | — | ||
data | List[TaskLogResponse] | Да | — |
McpOperationAccepted
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
operation_id | UUID | Да | — | ||
task_id | UUID | Да | — | Задача mcp, в которой операция доставляется Экстрактору | |
method | str | Да | — | ||
status | str | Да | — | queued | running | completed | failed | recovery_required | cancelled | |
result_ready | bool | Да | — |
McpOperationCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
operation_id | UUID | Да | — | UUID операции; равен Idempotency-Key, тот же для повторов и чтения | |
method | str | Да | — | Одно из 18 фиксированных имён метода (metadata/describe, projects/create, …) | min_length=1, max_length=100 |
payload | Dict[str, Any] | Да | — | JSON-объект; закрытая схема выбранного метода |
McpOperationResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
operation_id | UUID | Да | — | ||
task_id | UUID | Да | — | Задача mcp, в которой операция доставляется Экстрактору | |
method | str | Да | — | ||
status | str | Да | — | queued | running | completed | failed | recovery_required | cancelled | |
result_ready | bool | Да | — | ||
http_status | Optional[int] | Нет | None | Код бизнес-метода 1С (не сетевой статус); у failed внешний HTTP остаётся 200 | |
result | Optional[Union[Dict[str, Any], List[Any]]] | Нет | None | Точный JSON-результат метода 1С, включая прикладные ошибки | |
created_at | datetime | Да | — | ||
received_at | Optional[datetime] | Нет | None | Когда Экстрактор подтвердил получение задачи (ACK) | |
completed_at | Optional[datetime] | Нет | None | ||
last_connector_contact | Optional[datetime] | Нет | None | Последний heartbeat коннектора (опрос tasks/pending), отдельно от времени создания | |
source | Optional[str] | Нет | None | ||
expires_at | Optional[datetime] | Нет | None | До какого срока операция и результат хранятся (MCP_RESULT_RETENTION_DAYS) | |
diagnostic | Optional[str] | Нет | None | OPERATION_CANCELLED | RECOVERY_REQUIRED: результата нет, успехом не маскируется |
McpResultRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
operation_id | UUID | Да | — | ||
method | str | Да | — | min_length=1, max_length=100 | |
http_status | StrictInt | Да | — | Код бизнес-метода 1С (успешный в EPA API — 200), не статус этого запроса | ge=100, le=599 |
result | Union[Dict[str, Any], List[Any]] | Да | — | Точный JSON-объект или массив метода, включая ошибки; не усекается |
McpResultStoredResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
task_id | UUID | Да | — | ||
operation_id | UUID | Да | — | ||
result_stored | bool | Да | — |
Meta
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
page_size | Optional[int] | Нет | None | ||
offset | Optional[int] | Нет | None | ||
total | Optional[int] | Нет | None | ||
update | Optional[UpdateInfo] | Нет | None | ||
request_id | Optional[str] | Нет | None | Идентификатор запроса |
MetadataSyncRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
force | bool | Нет | False | Полная (принудительная) синхронизация кэша |
MetadataSyncResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ||
task_id | str | Да | — | ID задачи синхронизации, поставленной Коннектору | |
force | bool | Да | — | ||
status | str | None | Нет | None | Начальный статус задачи |
ObjectDescription
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок | |
object | Dict[str, Any] | Да | — | Нормализованное описание: поля, типы, свойства регистров | |
source | Dict[str, Any] | Да | — | Раздел и имя объекта так, как они в сохранённом снимке |
ObjectSummary
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
fullName | str | Да | — | ||
sourceFullName | str | Да | — | ||
kind | str | Да | — | ||
section | str | Да | — | ||
grain | str | Да | — | ||
owner | Optional[str] | Нет | None | ||
synonym | Optional[str] | Нет | None | ||
fieldCount | int | Да | — |
ObjectsPage
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок | |
items | List[ObjectSummary] | Да | — | ||
total | int | Да | — | ||
nextCursor | Optional[int] | Нет | None |
PaginationResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
limit | int | Да | — | ||
offset | int | Да | — | ||
count | int | Да | — | ||
data | List[T] | Да | — |
ProjectChangeStatusRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
status | str | Да | — | active, archived, deleted |
ProjectCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | UUID | Да | — | ||
id_project | Optional[UUID] | Нет | None | ||
name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | ||
project_path | Optional[str] | Нет | None | ||
parent_id_project | Optional[UUID] | Нет | None | ||
is_template | bool | Нет | False | Является ли проект шаблоном | |
template_project_id | Optional[UUID] | Нет | None | ID проекта-шаблона, от которого наследуется данный проект | |
data | Optional[Dict[str, Any]] | Нет | None | ||
template | Optional[str] | Нет | None |
ProjectDataResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | UUID | Да | — | ||
project_id | UUID | Да | — | ||
version | int | Да | — | ||
data | Optional[Dict[str, Any]] | Нет | {} | ||
template | Optional[str] | Да | — | ||
created_at | Optional[datetime] | Нет | None |
ProjectExportSchema
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | ||
project_path | Optional[str] | Нет | None | ||
parent_id_project | Optional[UUID] | Нет | None | ||
is_template | bool | Нет | False | ||
template_project_id | Optional[UUID] | Нет | None | ||
data | Optional[Dict[str, Any]] | Нет | None | ||
template | Optional[str] | Нет | None | ||
source_connector_id | Optional[UUID] | Нет | None | Коннектор-источник | |
last_version | Optional[int] | Нет | None |
ProjectGroupCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | str | Да | — | Название группы (папки) | |
parent_id | Optional[UUID] | Нет | None | ID родительской группы (null — корень) |
ProjectGroupResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | str | Да | — | ||
id_connector | str | Да | — | ||
name | str | Да | — | ||
parent_id | Optional[str] | Нет | None | ||
is_deleted | bool | Нет | False | ||
ecc_dt | Optional[datetime] | Нет | None |
ProjectGroupTreeNode
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | str | Да | — | ||
id_connector | str | Да | — | ||
name | str | Да | — | ||
parent_id | Optional[str] | Нет | None | ||
is_deleted | bool | Нет | False | ||
ecc_dt | Optional[datetime] | Нет | None | ||
children | List['ProjectGroupTreeNode'] | Нет | [] |
ProjectGroupUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | Optional[str] | Нет | None | Новое название группы | |
parent_id | Optional[UUID] | Нет | None | Новый родитель. Передайте null для переноса в корень; не передавайте поле, чтобы не менять родителя. |
ProjectImportRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | UUID | Да | — | Целевой коннектор | |
id_project | Optional[UUID] | Нет | None | Желаемый ID проекта (опц.) | |
project | ProjectExportSchema | Да | — |
ProjectResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | UUID | Да | — | ||
connector_id | UUID | Да | — | ||
name | Optional[str] | Да | — | ||
type | Optional[str] | Да | — | ||
project_path | Optional[str] | Да | — | ||
parent_id_project | Optional[UUID] | Да | — | ||
status | str | Да | — | ||
is_deleted | bool | Да | — | ||
is_template | bool | Нет | False | ||
template_project_id | Optional[UUID] | Нет | None | ||
data | Optional[Dict[str, Any]] | Нет | None | ||
template | Optional[str] | Нет | None | ||
last_version | Optional[int] | Нет | None | ||
id_db_connection | Optional[str] | Нет | None | ID подключения проекта в контракте 1С (для load_template); null — не задано | |
group_name | Optional[str] | Нет | None |
ProjectSnapshotRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
message_id | Optional[str] | Нет | None | ID исходящего сообщения 1С (трассировка) | |
timestamp | Optional[datetime] | Нет | None | Время сообщения, ISO 8601 с часовым поясом | |
id_connector | Optional[UUID] | Нет | None | Если передан — обязан совпадать с путём | |
id_project | Optional[UUID] | Нет | None | Если передан — обязан совпадать с путём | |
name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | project | group | другой тип Экстрактора | |
version | Optional[str] | Нет | None | Версия проекта в 1С | |
group_name | Optional[str] | Нет | None | ||
project_path | Optional[str] | Нет | None | ||
parent_id_project | Optional[str] | Нет | None | UUID родителя (группы); нулевой UUID — корень. Родитель загружается раньше | |
id_db_connection | Optional[str] | Нет | None | ID подключения 1С; нулевой UUID — нет. Подключение загружается раньше | |
is_deleted | Optional[bool] | Нет | None | ||
data | Optional[Dict[str, Any]] | Нет | None | Описание проекта (JSON Экстрактора) | |
template | Optional[str] | Нет | None | Шаблон проекта (непрозрачная строка) |
ProjectSnapshotResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
project | ProjectSnapshotView | Да | — | ||
created | bool | Да | — | Проект создан этим снимком | |
version_created | bool | Да | — | Снимок создал новую версию data/template |
ProjectSnapshotView
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ||
id_project | str | Да | — | ||
name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | ||
version | Optional[str] | Нет | None | ||
group_name | Optional[str] | Нет | None | ||
project_path | Optional[str] | Нет | None | ||
parent_id_project | Optional[str] | Нет | None | ||
id_db_connection | Optional[str] | Нет | None | ||
is_deleted | Optional[bool] | Нет | None | ||
timestamp | Optional[datetime] | Нет | None | ||
ecc_dt | Optional[datetime] | Нет | None | ||
last_version | Optional[int] | Нет | None | Последняя версия data/template |
ProjectUpdateDataRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
data | Optional[Dict[str, Any]] | Нет | None | ||
template | Optional[str] | Нет | None |
ProjectUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
name | Optional[str] | Нет | None | ||
type | Optional[str] | Нет | None | ||
project_path | Optional[str] | Нет | None | ||
parent_id_project | Optional[UUID] | Нет | None | ||
is_template | Optional[bool] | Нет | None | ||
template_project_id | Optional[UUID] | Нет | None |
ReferenceGraphRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
object | str | Да | — | min_length=1, max_length=512 | |
expand_paths | List[str] | Нет | [] | max_length=100 | |
max_depth | int | Нет | 4 | ge=1, le=10 | |
max_nodes | int | Нет | 500 | ge=1, le=1000 | |
max_edges | int | Нет | 2000 | ge=1, le=10000 | |
include_tabular_sections | bool | Нет | True | ||
account_scope | Optional[Dict[str, Any]] | Нет | None | Назначенные субконто счетов — живые данные 1С; по снимку граф с ним НЕ полный | |
snapshot_id | Optional[str] | Нет | None | Фиксировать обход на этом снимке |
ReferenceGraphResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок | |
object | str | Да | — | ||
nodes | List[Dict[str, Any]] | Да | — | ||
edges | List[Dict[str, Any]] | Да | — | ||
tree | Dict[str, Any] | Да | — | ||
metadataEnriched | bool | Да | — | ||
truncated | bool | Да | — | ||
complete | bool | Да | — | Относится к запрошенной области раскрытия, а не ко всей конфигурации | |
graphWarnings | List[str] | Нет | [] | ||
unresolvedExpandPaths | List[str] | Нет | [] | ||
accountAnalytics | Optional[Dict[str, Any]] | Нет | None |
ScheduleCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
cron | str | Да | — | Cron-выражение (5 или 6 полей) | |
is_active | bool | Нет | True | ||
timezone | TimezoneStr | Нет | None | IANA-таймзона (напр. Europe/Moscow) | |
start_dt | Optional[datetime] | Нет | None | ||
end_dt | Optional[datetime] | Нет | None |
ScheduleResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | str | Да | — | ||
id_connector | str | Да | — | ||
id_project | str | Да | — | ||
cron | str | Да | — | ||
is_active | bool | Да | — | ||
timezone | Optional[str] | Нет | None | ||
start_dt | Optional[datetime] | Нет | None | ||
end_dt | Optional[datetime] | Нет | None | ||
ecc_dt | Optional[datetime] | Нет | None |
ScheduleUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
cron | Optional[str] | Нет | None | Cron-выражение (5 или 6 полей) | |
is_active | Optional[bool] | Нет | None | ||
timezone | TimezoneStr | Нет | None | IANA-таймзона (напр. Europe/Moscow) | |
start_dt | Optional[datetime] | Нет | None | ||
end_dt | Optional[datetime] | Нет | None |
SnapshotBlock
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок |
SnapshotInfo
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
snapshotId | str | Да | — | Снимок, к которому относится ответ; страницы и граф — к одному снимку | |
sourceVersions | Dict[str, int] | Да | — | Версии сохранённых разделов, по которым собран снимок | |
receivedAt | Optional[datetime] | Нет | None | Самое позднее время ПРИЁМА раздела DCC (не время изменения конфигурации в 1С) | |
warnings | List[str] | Нет | [] | Предупреждения нормализации снимка | |
buildError | Optional[str] | Нет | None | Актуальный снимок построить не удалось: отдан предыдущий готовый снимок | |
createdAt | datetime | Да | — | ||
normalizerVersion | str | Да | — | ||
objectCount | int | Да | — | ||
fieldCount | int | Да | — | ||
sections | Dict[str, Any] | Да | — | По каждому разделу: версия, время приёма, число объектов | |
complete | bool | Да | — | Нет предупреждений и ошибки сборки |
TaskCancelRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
reason | Optional[str] | Нет | None | Причина отмены |
TaskCreateBase
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) |
TaskEventResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | UUID | Да | — | ||
task_id | UUID | Да | — | ||
connector_id | UUID | Да | — | ||
event_type | str | Да | — | TaskCreated | TaskStatusChanged | TaskDataUpdated | TaskDeleted | |
old_status | Optional[str] | Нет | None | ||
new_status | Optional[str] | Нет | None | ||
status_info | Optional[str] | Нет | None | ||
payload | Optional[Dict[str, Any]] | Нет | None | ||
occurred_at | Optional[datetime] | Нет | None |
TaskLogCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_connector | str | Да | — | ID коннектора | |
id_project | str | Да | — | ID проекта | |
id_task | str | Да | — | ID задачи | |
id_line | Optional[str] | Нет | None | ID строки в проекте. Не передаётся (или null/"") для логов уровня проекта/задачи: initial_project, exec и т.п. | |
level | str | Да | — | Уровень логирования (Emergency, Alert, Critical, Error, Warning, Notice, Informational, Debug) | |
data | Optional[Dict[str, Any]] | Нет | None | JSON с данными | |
segment | Optional[str] | Нет | None | Выгружаемый сегмент данных | |
count | Optional[int] | Нет | None | Количество строк | ge=0 |
timestamp | Optional[datetime] | Нет | None | Время события | |
message_id | Optional[str] | Нет | None | Устойчивый ID сообщения лога (extractor-1c/2.0): повтор с тем же message_id не дублирует запись | max_length=200 |
count_type | Optional[Union[str, int, float, bool, Dict[str, Any], List[Any]]] | Нет | None | Тип счётчика в формате Экстрактора (сохраняется как есть) |
TaskLogResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id_log | UUID | Да | — | ||
id_connector | str | Да | — | ||
id_project | str | Да | — | ||
id_task | str | Да | — | ||
id_line | Optional[str] | Нет | None | null — лог уровня проекта/задачи, без строки | |
level | str | Да | — | ||
data | Optional[Dict[str, Any]] | Нет | {} | ||
segment | Optional[str] | Да | — | ||
count | Optional[int] | Да | — | ||
timestamp | Optional[datetime] | Да | — | ||
ecc_dt | Optional[datetime] | Да | — | ||
is_deleted | bool | Да | — | ||
message_id | Optional[str] | Нет | None | ||
count_type | Optional[Any] | Нет | None |
TaskReportCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | UUID | Да | — | Устойчивый UUID запуска в 1С | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['report'] | Да | — | report — регистрация запуска 1С | |
status | Literal['started'] | Нет | 'started' | Единственный допустимый начальный статус | |
command_type | CommandType | Да | — | Тип команды, которую исполняет 1С | |
data | Optional[Dict[str, Any]] | Нет | {} | Payload в формате Экстрактора |
TaskResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
task_id | UUID | Да | — | ||
connector_id | UUID | Да | — | ||
project_id | Optional[UUID] | Нет | None | ||
parent_project_id | Optional[UUID] | Нет | None | ||
command_type | Optional[Union[CommandType, str]] | Нет | None | ||
timestamp | Optional[datetime] | Нет | None | ||
status | Optional[str] | Нет | None | ||
data | Dict[str, Any] | Нет | {} | ||
status_info | Optional[str] | Нет | None | ||
source | Optional[str] | Нет | None | ||
created_by | Optional[str] | Нет | None | ||
updated_by | Optional[str] | Нет | None | ||
ecc_dt | Optional[datetime] | Нет | None | ||
is_deleted | bool | Нет | False | ||
delivery_mode | Optional[str] | Нет | None | dispatch | report (null — задача v1) | |
delivered_at | Optional[datetime] | Нет | None | Первый ACK (received); null — не доставлена | |
created_at | Optional[datetime] | Нет | None | ||
parent_id_task | Optional[UUID] | Нет | None | Родительский запуск |
TaskStatusDetailResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
task_id | UUID | Да | — | ||
connector_id | UUID | Да | — | ||
status | str | Да | — | ||
status_info | Optional[str] | Нет | None | ||
updated_at | Optional[datetime] | Нет | None | Время последнего изменения (ecc_dt) | |
is_terminal | bool | Да | — | Терминальный статус (success/error/cancelled) | |
allowed_transitions | List[str] | Да | — | Статусы, в которые можно перейти из текущего | |
delivered_at | Optional[datetime] | Нет | None | Время первого ACK (received); null — не доставлена |
TaskStatusPatchRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
status | TaskStatusValue | Да | — | Новый статус (см. матрицу переходов) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе |
TaskStatusResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
tasks | List[TaskResponse] | Да | — |
TaskStatusWaitResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
task_id | UUID | Да | — | ||
connector_id | UUID | Да | — | ||
status | str | Да | — | ||
status_info | Optional[str] | Нет | None | ||
updated_at | Optional[datetime] | Нет | None | Время последнего изменения (ecc_dt) | |
is_terminal | bool | Да | — | Терминальный статус (success/error/cancelled) | |
allowed_transitions | List[str] | Да | — | Статусы, в которые можно перейти из текущего | |
delivered_at | Optional[datetime] | Нет | None | Время первого ACK (received); null — не доставлена | |
timed_out | bool | Нет | False | true — истёк timeout, дождаться события не удалось | |
waited_for | str | Нет | 'change' | change — любая смена; terminal — до финального статуса |
TaskUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
data | Dict[str, Any] | Нет | {} | Новая полезная нагрузка задачи (JSON) |
TaskUpdateStatusRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
task_id | UUID | Да | — | ID задачи | |
connector_id | UUID | Да | — | ID коннектора | |
status | TaskStatusValue | Да | — | Новый статус: new, waiting, received, started, success, error, cancelled. Переходы: new→waiting/received; waiting→received; received→started; started→success; любой активный→error/cancelled; error→waiting (ретрай). Terminal: success, error, cancelled. Недопустимый переход → 422. | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе |
TasksPageResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
count | int | Да | — | ||
limit | int | Да | — | ||
offset | int | Да | — | ||
data | List[TaskResponse] | Да | — |
UpdateInfo
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
triggered | bool | Нет | False | ||
task_id | Optional[UUID] | Нет | None | ||
status | Optional[str] | Нет | None | ||
reason | Optional[str] | Нет | None | Почему доставка не создана, напр. UNSUPPORTED_CONNECTOR_COMMAND (изменение сохранено в DCC, но в коннектор не отправлено) |
UpdateTaskCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
connector_id | UUID | Да | — | ID коннектора | |
task_id | Optional[UUID] | Нет | None | ID задачи (генерируется, если не задан) | |
project_id | Optional[UUID] | Нет | None | ID проекта в рамках коннектора | |
parent_project_id | Optional[UUID] | Нет | None | ID родительского проекта | |
parent_id_task | Optional[UUID] | Нет | None | ID родительского запуска (связь родительского и дочернего запусков); пустая строка = нет | |
timestamp | Optional[datetime] | Нет | None | Время создания задачи (ISO 8601 с часовым поясом) | |
status_info | Optional[str] | Нет | None | Доп. информация о статусе | |
source | Optional[str] | Нет | None | Источник задачи (на режим доставки не влияет) | |
delivery_mode | Literal['dispatch'] | Нет | 'dispatch' | dispatch — команда DCC; report — см. TaskReportCreate | |
status | Optional[Literal['waiting']] | Нет | None | Для dispatch статус задаёт жизненный цикл: не передаётся (или waiting) | |
command_type | Literal[CommandType.UPDATE] | Нет | CommandType.UPDATE | ||
data | UpdateTaskData | Да | — | Что и как изменилось |
UpdateTaskData
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
entity | UpdateEntity | Да | — | Тип изменённой сущности | |
operation | UpdateOperation | Да | — | Операция: create/update/delete | |
connector_id | str | Да | — | ID коннектора (scope доставки) | |
entity_id | str | Да | — | ID изменённой сущности (для entity=connector совпадает с connector_id) | |
changes | Dict[str, Any] | Нет | {} | Снапшот изменений |
UserCreate
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
login | str | Да | — | min_length=1, max_length=255 | |
password | str | Да | — | min_length=1 | |
name | str | Да | — | min_length=1 | |
lastname | str | Нет | '' | ||
is_admin | bool | Нет | False |
UserLogin
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
login | str | Да | — | ||
password | str | Да | — |
UserResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
login | str | Да | — | ||
name | str | Да | — | ||
lastname | str | None | Да | — | ||
is_admin | bool | Да | — | ||
is_deleted | bool | Да | — | ||
ecc_dt | datetime | Да | — |
WebhookCreateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
url | HttpUrlStr | Да | — | URL для callback-уведомления | |
event | WebhookEvent | Да | — | Событие подписки | |
is_active | bool | Нет | True | ||
secret | Optional[str] | Нет | None | Секрет для подписи запроса | |
id_connector | Optional[str] | Нет | None | Ограничить подписку коннектором |
WebhookResponse
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
id | str | Да | — | ||
url | str | Да | — | ||
event | WebhookEvent | Да | — | ||
is_active | bool | Да | — | ||
has_secret | bool | Нет | False | ||
id_connector | Optional[str] | Нет | None | ||
ecc_dt | Optional[datetime] | Нет | None |
WebhookUpdateRequest
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
url | Optional[HttpUrlStr] | Нет | None | URL для callback-уведомления | |
event | Optional[WebhookEvent] | Нет | None | Событие подписки | |
is_active | Optional[bool] | Нет | None | ||
secret | Optional[str] | Нет | None | Секрет для подписи запроса |
_CapabilitiesMixin
Поле | Тип | Обязательное | По умолчанию | Назначение | Ограничения |
client_contract | Optional[str] | Нет | None | Контракт клиента, напр. extractor-1c/2.0 | |
supported_commands | Optional[List[str]] | Нет | None | Команды, которые клиент умеет исполнять (типы задач + cancel). DCC не ставит на доставку остальные (409 UNSUPPORTED_CONNECTOR_COMMAND). null — не объявлено (коннектор получает всё, как раньше). |
Варианты создания задачи
TaskCreateRequest выбирает схему по command_type и delivery_mode. Для exec — ExecTaskCreate, для initial_project — InitialProjectTaskCreate, для load_template — LoadTemplateTaskCreate. Другие варианты и допустимые значения полей проверяйте в OpenAPI. Для report применяется TaskReportCreate; наличие source не превращает команду в отчёт.
Значения перечислений
Тип | Значения |
|
|
|
|
|
|
|
|
|
|
|
|
TaskCreateRequest также включает AddQueueTaskCreate, UpdateTaskCreate и ExtractorInstallTaskCreate. Неизвестный command_type или несовместимый delivery_mode отклоняется сервером. Команда mcp создаётся через API операций MCP; регистрация её как report запрещена.