La référence de l'API est publiée en anglais.

Update a work product

PATCH/api/work-products/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Update a work product.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe work product's id.

Corps de la requête

application/json · obligatoire

projectIdstring (uuid) | nullFacultatif
executionWorkspaceIdstring (uuid) | nullFacultatif
runtimeServiceIdstring (uuid) | nullFacultatif
typestringFacultatifone of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"
providerstringFacultatifat least 1 character
externalIdstring | nullFacultatif
titlestringFacultatifat least 1 character
urlstring (uri) | nullFacultatif
statusstringFacultatifone of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"
reviewStatestringFacultatifone of: "none", "needs_board_review", "approved", "changes_requested"
isPrimarybooleanFacultatif
healthStatusstringFacultatifone of: "unknown", "healthy", "unhealthy"
summarystring | nullFacultatif
metadataobject | nullFacultatif
metadata.resourceRefobject | nullFacultatif
metadata.resourceRef.kindstringObligatoireone of: "workspace_file"
metadata.resourceRef.issueIdstring (uuid)Facultatif
metadata.resourceRef.projectIdstring (uuid)Facultatif
metadata.resourceRef.projectNamestringFacultatifat least 1 character
metadata.resourceRef.workspaceKindstringObligatoireone of: "execution_workspace", "project_workspace"
metadata.resourceRef.workspaceIdstring (uuid)Obligatoire
metadata.resourceRef.relativePathstringObligatoireat least 1 character
metadata.resourceRef.lineinteger | nullFacultatif> 0
metadata.resourceRef.columninteger | nullFacultatif> 0
metadata.resourceRef.displayPathstringObligatoireat least 1 character
createdByRunIdstring (uuid) | nullFacultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Tasks