API referansı İngilizce yayımlanır.

Update a routine

PATCH/api/routines/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Update a routine.

Agents can update only routines assigned to them and cannot reassign them. A routine with a non-null managedByPlugin is a plugin-managed routine: that plugin created it and owns its definition (title, instructions, schedule, assignee), and the plugin can reset it to its manifest defaults. It is changed through the settings that plugin exposes, which a member opens at plugin settings, with managedByPlugin.pluginId as and this conversation's organization prefix as . Do not rewrite, detach or duplicate a plugin-managed routine to imitate a change, and do not search for another route: reply now with that link and the routine's page link.

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 routine's id.

İstek gövdesi

application/json · zorunlu

projectIdstring (uuid) | nullİsteğe bağlı
folderIdstring (uuid) | nullİsteğe bağlı
goalIdstring (uuid) | nullİsteğe bağlı
parentIssueIdstring (uuid) | nullİsteğe bağlı
titlestringİsteğe bağlı1–200 characters
descriptionstring | nullİsteğe bağlı
assigneeAgentIdstring (uuid) | nullİsteğe bağlı
prioritystringİsteğe bağlıone of: "critical", "high", "medium", "low"
statusstringİsteğe bağlıone of: "active", "paused", "archived"
concurrencyPolicystringİsteğe bağlıone of: "coalesce_if_active", "always_enqueue", "skip_if_active"
catchUpPolicystringİsteğe bağlıone of: "skip_missed", "enqueue_missed_with_cap"
activityGatePolicystringİsteğe bağlıone of: "always", "require_external_activity"
activityGateScopestringİsteğe bağlıone of: "company", "project"
variablesarray<object>İsteğe bağlı
variables[].namestringZorunlupattern: ^[A-Za-z][A-Za-z0-9_]*$
variables[].labelstring | nullİsteğe bağlıat most 120 characters
variables[].typestringİsteğe bağlıone of: "text", "textarea", "number", "boolean", "select", "date"
variables[].defaultValuestring | number | boolean | nullİsteğe bağlı
variables[].requiredbooleanİsteğe bağlı
variables[].optionsarray<string>İsteğe bağlıeach at most 120 characters
envobject<string, string | object> | nullİsteğe bağlı
baseRevisionIdstring (uuid) | nullİsteğe bağlı
responsibleUserIdstringİsteğe bağlıat least 1 character

Yanıtlar

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.

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

Routines