К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-patchcatalogitem.mdиндекс документации — /llms.txt

patchCatalogItem

Обновлено

PATCH /api/v1/catalog/{seq_id}

patchCatalogItem

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["catalog:write"]

Параметры запроса

ПолеЗначение
0.in"path"
0.name"seq_id"
0.requiredtrue
0.schema0.schema
1.in"query"
1.name"zone"
1.requiredfalse
1.schema1.schema
2.in"header"
2.name"If-Match"
2.requiredtrue
2.schema2.schema
3.in"header"
3.name"Idempotency-Key"
3.requiredtrue
3.schema3.schema

Тело запроса

ПолеЗначение
content.application/json.schemaCatalogPatch
requiredtrue

Ответы

ПолеЗначение
200.content.application/json.schemaCatalogDetail
200.description"Patch catalog item"
200.headers.ETag.description"Weak ETag for the current catalog item representation"
200.headers.ETag.requiredtrue
200.headers.ETag.schema200.headers.ETag.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Idempotency-Key must contain between 1 and 128 characters"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing or invalid API key"
403.content.application/problem+json.schemaProblemDetails
403.description"Catalog write scope or resource policy refused the request"
404.content.application/problem+json.schemaProblemDetails
404.description"Catalog item was not found for the authenticated tenant"
409.content.application/problem+json.schemaProblemDetails
409.description"Catalog command with this identity is already in progress, or the patch attempts to rename, remove, or reuse a durable variant key"
412.content.application/problem+json.schemaProblemDetails
412.description"If-Match does not match the current catalog item ETag; the Problem Details current_etag extension and ETag response header identify the winning version"
412.headers.ETag.description"Weak ETag for the current catalog item representation"
412.headers.ETag.requiredtrue
412.headers.ETag.schema412.headers.ETag.schema
422.content.application/problem+json.schemaProblemDetails
422.description"Catalog patch is invalid or contains a read-only field"
428.content.application/problem+json.schemaProblemDetails
428.description"If-Match and Idempotency-Key headers are required"

Дополнительные условия

ПолеЗначение
description"Requires an API key credential, supplied in X-Api-Key or Authorization: Bearer tgf_*. Surface-session JWT credentials are not accepted for this operation."
operationId"patchCatalogItem"
tags["catalog"]
x-idempotency"durable-receipt"