La referencia de la API se publica en inglés.
Create a task work product
POST
/api/issues/{id}/work-productsPersonal API keyAgent API keyConsole session
Create a task 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 task's id.
Cuerpo de la solicitud
application/json · obligatorio
projectIdstring (uuid) | nullOpcional
executionWorkspaceIdstring (uuid) | nullOpcional
runtimeServiceIdstring (uuid) | nullOpcional
typestringObligatorio
one of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"providerstringObligatorio
at least 1 characterexternalIdstring | nullOpcional
titlestringObligatorio
at least 1 characterurlstring (uri) | nullOpcional
statusstringOpcional
one of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"reviewStatestringOpcional
one of: "none", "needs_board_review", "approved", "changes_requested"isPrimarybooleanOpcional
healthStatusstringOpcional
one of: "unknown", "healthy", "unhealthy"summarystring | nullOpcional
metadataobject | nullOpcional
metadata.resourceRefobject | nullOpcional
metadata.resourceRef.kindstringObligatorio
one of: "workspace_file"metadata.resourceRef.issueIdstring (uuid)Opcional
metadata.resourceRef.projectIdstring (uuid)Opcional
metadata.resourceRef.projectNamestringOpcional
at least 1 charactermetadata.resourceRef.workspaceKindstringObligatorio
one of: "execution_workspace", "project_workspace"metadata.resourceRef.workspaceIdstring (uuid)Obligatorio
metadata.resourceRef.relativePathstringObligatorio
at least 1 charactermetadata.resourceRef.lineinteger | nullOpcional
> 0metadata.resourceRef.columninteger | nullOpcional
> 0metadata.resourceRef.displayPathstringObligatorio
at least 1 charactercreatedByRunIdstring (uuid) | nullOpcional
Respuestas
201SuccessCreated; the body holds the new resource.
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.