API referansı İngilizce yayımlanır.

Create a task work product

POST/api/issues/{id}/work-products
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create a task work product.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

idstringZorunluThe task's id.

İstek gövdesi

application/json · zorunlu

projectIdstring (uuid) | nullİsteğe bağlı
executionWorkspaceIdstring (uuid) | nullİsteğe bağlı
runtimeServiceIdstring (uuid) | nullİsteğe bağlı
typestringZorunluone of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"
providerstringZorunluat least 1 character
externalIdstring | nullİsteğe bağlı
titlestringZorunluat least 1 character
urlstring (uri) | nullİsteğe bağlı
statusstringİsteğe bağlıone of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"
reviewStatestringİsteğe bağlıone of: "none", "needs_board_review", "approved", "changes_requested"
isPrimarybooleanİsteğe bağlı
healthStatusstringİsteğe bağlıone of: "unknown", "healthy", "unhealthy"
summarystring | nullİsteğe bağlı
metadataobject | nullİsteğe bağlı
metadata.resourceRefobject | nullİsteğe bağlı
metadata.resourceRef.kindstringZorunluone of: "workspace_file"
metadata.resourceRef.issueIdstring (uuid)İsteğe bağlı
metadata.resourceRef.projectIdstring (uuid)İsteğe bağlı
metadata.resourceRef.projectNamestringİsteğe bağlıat least 1 character
metadata.resourceRef.workspaceKindstringZorunluone of: "execution_workspace", "project_workspace"
metadata.resourceRef.workspaceIdstring (uuid)Zorunlu
metadata.resourceRef.relativePathstringZorunluat least 1 character
metadata.resourceRef.lineinteger | nullİsteğe bağlı> 0
metadata.resourceRef.columninteger | nullİsteğe bağlı> 0
metadata.resourceRef.displayPathstringZorunluat least 1 character
createdByRunIdstring (uuid) | nullİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Tasks