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
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
typestringFacultatif
one of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"providerstringFacultatif
at least 1 characterexternalIdstring | nullFacultatif
titlestringFacultatif
at least 1 characterurlstring (uri) | nullFacultatif
statusstringFacultatif
one of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"reviewStatestringFacultatif
one of: "none", "needs_board_review", "approved", "changes_requested"isPrimarybooleanFacultatif
healthStatusstringFacultatif
one of: "unknown", "healthy", "unhealthy"summarystring | nullFacultatif
metadataobject | nullFacultatif
metadata.resourceRefobject | nullFacultatif
metadata.resourceRef.kindstringObligatoire
one of: "workspace_file"metadata.resourceRef.issueIdstring (uuid)Facultatif
metadata.resourceRef.projectIdstring (uuid)Facultatif
metadata.resourceRef.projectNamestringFacultatif
at least 1 charactermetadata.resourceRef.workspaceKindstringObligatoire
one of: "execution_workspace", "project_workspace"metadata.resourceRef.workspaceIdstring (uuid)Obligatoire
metadata.resourceRef.relativePathstringObligatoire
at least 1 charactermetadata.resourceRef.lineinteger | nullFacultatif
> 0metadata.resourceRef.columninteger | nullFacultatif
> 0metadata.resourceRef.displayPathstringObligatoire
at least 1 charactercreatedByRunIdstring (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.