Справочник API публикуется на английском языке.
Update a work product
PATCH
/api/work-products/{id}Personal API keyAgent API keyConsole session
Update a work product.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
idstringОбязательныйThe work product's id.
Тело запроса
application/json · обязательно
projectIdstring (uuid) | nullНеобязательный
executionWorkspaceIdstring (uuid) | nullНеобязательный
runtimeServiceIdstring (uuid) | nullНеобязательный
typestringНеобязательный
one of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"providerstringНеобязательный
at least 1 characterexternalIdstring | nullНеобязательный
titlestringНеобязательный
at least 1 characterurlstring (uri) | nullНеобязательный
statusstringНеобязательный
one of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"reviewStatestringНеобязательный
one of: "none", "needs_board_review", "approved", "changes_requested"isPrimarybooleanНеобязательный
healthStatusstringНеобязательный
one of: "unknown", "healthy", "unhealthy"summarystring | nullНеобязательный
metadataobject | nullНеобязательный
metadata.resourceRefobject | nullНеобязательный
metadata.resourceRef.kindstringОбязательный
one of: "workspace_file"metadata.resourceRef.issueIdstring (uuid)Необязательный
metadata.resourceRef.projectIdstring (uuid)Необязательный
metadata.resourceRef.projectNamestringНеобязательный
at least 1 charactermetadata.resourceRef.workspaceKindstringОбязательный
one of: "execution_workspace", "project_workspace"metadata.resourceRef.workspaceIdstring (uuid)Обязательный
metadata.resourceRef.relativePathstringОбязательный
at least 1 charactermetadata.resourceRef.lineinteger | nullНеобязательный
> 0metadata.resourceRef.columninteger | nullНеобязательный
> 0metadata.resourceRef.displayPathstringОбязательный
at least 1 charactercreatedByRunIdstring (uuid) | nullНеобязательный
Ответы
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.