Aggiorna la pianificazione

Aggiorna una pianificazione esistente.

PATCH /v3/organizations/{org_id}/schedules/{schedule_id}

Aggiorna la pianificazione

cURL

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 '
{
  "bypass_approval": true,
  "enabled": true,
  "frequency": "<string>",
  "interval_count": 123,
  "name": "<string>",
  "platform": "<string>",
  "playbook_id": "<string>",
  "prompt": "<string>",
  "run_as_user_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>",
  "tags": [
    "<string>"
  ],
  "target_devin_id": "<string>"
}
'

200

{
  "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>",
  "org_id": "<string>",
  "playbook": {
    "playbook_id": "<string>",
    "title": "<string>"
  },
  "prompt": "<string>",
  "scheduled_session_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "bypass_approval": false,
  "interval_count": 1,
  "last_edited_by": "<string>",
  "platform": "<string>",
  "schedule_type": "recurring",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "slack_channel_id": "<string>",
  "slack_team_id": "<string>",
  "tags": [
    "<string>"
  ],
  "target_devin_id": "<string>"
}

​

Autorizzazioni

Richiede un service user con l’autorizzazione ManageOrgSchedules a livello di organizzazione.

​

Note

Tutti i campi sono facoltativi. Verranno aggiornati solo i campi forniti nel corpo della richiesta. Per disabilitare una pianificazione, imposta enabled su false.

Impostare playbook_id su null rimuoverà il playbook associato.

Puoi modificare schedule_type tra recurring e one_time. Quando lo imposti su one_time, fornisci scheduled_at con una data e ora futura nel formato ISO 8601. Quando lo imposti su recurring, fornisci frequency con una espressione cron valida.

​

Identità di esecuzione

Il parametro run_as_user_id controlla con quale identità utente viene eseguita la pianificazione. Quando una pianificazione viene attivata, le sessioni vengono create con questo utente: riceve le notifiche e la sessione appare nella sua cronologia.

• Imposta un utente: Fornisci un ID utente valido per modificare l’identità di esecuzione. Questo richiede:
  1. L’utente di servizio deve avere l’autorizzazione ImpersonateOrgSessions
  2. L’utente di destinazione deve essere un membro dell’organizzazione
  3. L’utente di destinazione deve avere l’autorizzazione UseDevinSessions
• Reimposta (imposta a null): Fa sì che la pianificazione venga nuovamente eseguita come utente bot predefinito
• Ometti il campo: Lascia invariata l’identità di esecuzione corrente

Autorizzazioni

Authorization · string · header · obbligatorio

Credenziale utente di servizio (prefisso: cog_)

Parametri del percorso

schedule_id · string · obbligatorio

ID della pianificazione (prefisso: sched-)

Esempio:

"sched-abc123def456"

Corpo

application/json

agent · enum<string> | null

Opzioni disponibili: devin, data_analyst

bypass_approval · boolean | null

enabled · boolean | null

frequency · string | null

interval_count · integer | null

name · string | null

notify_on · enum<string> | null

Opzioni disponibili: always, failure, never

platform · string | null

Piattaforma VM per le sessioni generate da questa pianificazione (ad es. 'windows'). Se omessa, la piattaforma rimane invariata. Il valore deve corrispondere a una piattaforma configurata per l'organizzazione (senza distinzione tra maiuscole e minuscole); i valori sconosciuti vengono rifiutati con un 400 che elenca le etichette di piattaforma disponibili.

playbook_id · string | null

prompt · string | null

run_as_user_id · string | null

Imposta l'ID utente con cui verrà eseguita questa pianificazione. Richiede l'autorizzazione ImpersonateOrgSessions. Se impostato su null, viene ripristinato l'utente bot predefinito. Se il campo viene omesso, l'identità corrente rimane invariata.

schedule_type · enum<string> | null

Opzioni disponibili: recurring, one_time

scheduled_at · string<date-time> | null

slack_channel_id · string | null

slack_team_id · string | null

tags · string[] | null

target_devin_id · string | null

Risposta

200

application/json

Risposta di successo

agent · enum<string> · obbligatorio

Opzioni disponibili: devin, data_analyst

consecutive_failures · integer · obbligatorio

created_at · string<date-time> · obbligatorio

created_by · string | null · obbligatorio

enabled · boolean · obbligatorio

frequency · string | null · obbligatorio

last_error_at · string<date-time> | null · obbligatorio

last_error_message · string | null · obbligatorio

last_executed_at · string<date-time> | null · obbligatorio

name · string · obbligatorio

notify_on · enum<string> · obbligatorio

Opzioni disponibili: always, failure, never

org_id · string · obbligatorio

playbook · PlaybookInfo · object · obbligatorio

Show child attributes

prompt · string · obbligatorio

scheduled_session_id · string · obbligatorio

updated_at · string<date-time> · obbligatorio

bypass_approval · boolean · predefinito: false

interval_count · integer · predefinito: 1

last_edited_by · string | null

platform · string | null

schedule_type · enum<string> · predefinito: recurring

Opzioni disponibili: recurring, one_time

scheduled_at · string<date-time> | null

slack_channel_id · string | null

slack_team_id · string | null

tags · string[] | null

target_devin_id · string | null