La referencia de la API se publica en inglés.

Update a work product

PATCH/api/work-products/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Update a work product.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe work product's id.

Cuerpo de la solicitud

application/json · obligatorio

projectIdstring (uuid) | nullOpcional
executionWorkspaceIdstring (uuid) | nullOpcional
runtimeServiceIdstring (uuid) | nullOpcional
typestringOpcionalone of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"
providerstringOpcionalat least 1 character
externalIdstring | nullOpcional
titlestringOpcionalat least 1 character
urlstring (uri) | nullOpcional
statusstringOpcionalone of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"
reviewStatestringOpcionalone of: "none", "needs_board_review", "approved", "changes_requested"
isPrimarybooleanOpcional
healthStatusstringOpcionalone of: "unknown", "healthy", "unhealthy"
summarystring | nullOpcional
metadataobject | nullOpcional
metadata.resourceRefobject | nullOpcional
metadata.resourceRef.kindstringObligatorioone of: "workspace_file"
metadata.resourceRef.issueIdstring (uuid)Opcional
metadata.resourceRef.projectIdstring (uuid)Opcional
metadata.resourceRef.projectNamestringOpcionalat least 1 character
metadata.resourceRef.workspaceKindstringObligatorioone of: "execution_workspace", "project_workspace"
metadata.resourceRef.workspaceIdstring (uuid)Obligatorio
metadata.resourceRef.relativePathstringObligatorioat least 1 character
metadata.resourceRef.lineinteger | nullOpcional> 0
metadata.resourceRef.columninteger | nullOpcional> 0
metadata.resourceRef.displayPathstringObligatorioat least 1 character
createdByRunIdstring (uuid) | nullOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Tasks