Справочник API публикуется на английском языке.

Update a work product

PATCH/api/work-products/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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 character
externalIdstring | nullНеобязательный
titlestringНеобязательныйat least 1 character
urlstring (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 character
metadata.resourceRef.workspaceKindstringОбязательныйone of: "execution_workspace", "project_workspace"
metadata.resourceRef.workspaceIdstring (uuid)Обязательный
metadata.resourceRef.relativePathstringОбязательныйat least 1 character
metadata.resourceRef.lineinteger | nullНеобязательный> 0
metadata.resourceRef.columninteger | nullНеобязательный> 0
metadata.resourceRef.displayPathstringОбязательныйat least 1 character
createdByRunIdstring (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. Подробнее: ошибки и ограничения.

Tasks