Passer au contenu principal
PATCH
/
v3
/
organizations
/
{org_id}
/
schedules
/
{schedule_id}
Mettre à jour un planning
curl --request PATCH \
  --url https://api.devin.ai/v3/organizations/{org_id}/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "devin",
  "enabled": true,
  "frequency": "<string>",
  "name": "<string>",
  "notify_on": "always",
  "playbook_id": "<string>",
  "prompt": "<string>",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "run_as_user_id": "<string>",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>"
}
'
{
  "agent": "devin",
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "enabled": true,
  "frequency": "<string>",
  "last_error_at": "2023-11-07T05:31:56Z",
  "last_error_message": "<string>",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "notify_on": "always",
  "org_id": "<string>",
  "playbook": {
    "playbook_id": "<string>",
    "title": "<string>"
  },
  "prompt": "<string>",
  "scheduled_session_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>"
}

​
Permissions

Nécessite un compte de service disposant de l’autorisation ManageOrgSchedules au niveau de l’organisation.

​
Remarques

Tous les champs sont facultatifs. Seuls les champs fournis dans le corps de la requête seront mis à jour. Pour désactiver une planification, définissez enabled sur false. Définir playbook_id sur null effacera l’association avec le playbook. Vous pouvez modifier schedule_type entre recurring et one_time. Lorsque vous passez à one_time, renseignez scheduled_at avec une date et heure ISO 8601 ultérieure. Lorsque vous passez à recurring, renseignez frequency avec une expression cron valide.

​
Identité d’exécution

Le paramètre run_as_user_id contrôle l’identité utilisateur sous laquelle la planification s’exécute. Lorsqu’une planification se déclenche, les sessions sont créées pour cet utilisateur : il reçoit les notifications et la session apparaît dans son historique.
  • Définir un utilisateur : fournissez un ID utilisateur valide pour modifier l’identité d’exécution. Cela nécessite :
    1. Le compte de service doit disposer de l’autorisation ImpersonateOrgSessions
    2. L’utilisateur cible doit être membre de l’organisation
    3. L’utilisateur cible doit disposer de l’autorisation UseDevinSessions
  • Effacer (définir sur null) : rétablit l’exécution de la planification sous le bot par défaut
  • Omettre le champ : laisse l’identité d’exécution actuelle inchangée

Autorisations

​
Authorization
string
header
requis

Identifiant de compte de service (préfixe : cog_)

Paramètres de chemin

​
schedule_id
string
requis

Corps

application/json
​
agent
enum<string> | null
Options disponibles:
devin,
data_analyst,
advanced
​
enabled
boolean | null
​
frequency
string | null
​
name
string | null
​
notify_on
enum<string> | null
Options disponibles:
always,
failure,
never
​
playbook_id
string | null
​
prompt
string | null
​
schedule_type
enum<string> | null
Options disponibles:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
run_as_user_id
string | null

Définissez l’ID utilisateur sous lequel cette planification sera exécutée. Nécessite la permission ImpersonateOrgSessions. L’utilisateur cible doit être membre de l’organisation. Définir cette valeur sur null rétablit l’utilisateur bot par défaut. Si ce champ est omis, l’identité actuelle reste inchangée.

​
slack_channel_id
string | null
​
slack_team_id
string | null

Réponse

Réponse réussie

​
agent
enum<string>
requis
Options disponibles:
devin,
data_analyst,
advanced
​
consecutive_failures
integer
requis
​
created_at
string<date-time>
requis
​
created_by
string | null
requis
​
enabled
boolean
requis
​
frequency
string | null
requis
​
last_error_at
string<date-time> | null
requis
​
last_error_message
string | null
requis
​
last_executed_at
string<date-time> | null
requis
​
name
string
requis
​
notify_on
enum<string>
requis
Options disponibles:
always,
failure,
never
​
org_id
string
requis
​
playbook
PlaybookInfo · object
requis
​
prompt
string
requis
​
scheduled_session_id
string
requis
​
updated_at
string<date-time>
requis
​
schedule_type
enum<string>
défaut:recurring
Options disponibles:
recurring,
one_time
​
scheduled_at
string<date-time> | null
​
slack_channel_id
string | null
​
slack_team_id
string | null