Zeitplan aktualisieren

Einen vorhandenen Zeitplan aktualisieren.

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

Zeitplan aktualisieren

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>"
}

​

Berechtigungen

Erfordert einen Servicebenutzer mit der Berechtigung ManageOrgSchedules auf Organisationsebene.

​

Hinweise

Alle Felder sind optional. Nur die im Request-Body angegebenen Felder werden aktualisiert. Um einen Zeitplan zu deaktivieren, setzen Sie enabled auf false.

Wenn Sie playbook_id auf null setzen, wird das zugehörige Playbook gelöscht.

Sie können den schedule_type zwischen recurring und one_time ändern. Wenn Sie zu one_time wechseln, geben Sie scheduled_at mit einem zukünftigen Datum-Uhrzeit-Wert im ISO-8601-Format an. Wenn Sie zu recurring wechseln, geben Sie frequency mit einem gültigen Cron-Ausdruck an.

​

Ausführungsidentität

Der Parameter run_as_user_id steuert, unter welcher Benutzeridentität der Zeitplan ausgeführt wird. Wenn ein Zeitplan ausgelöst wird, werden Sitzungen für diesen Benutzer erstellt – er erhält Benachrichtigungen und die Sitzung erscheint in seinem Verlauf.

• Benutzer festlegen: Geben Sie eine gültige Benutzer-ID an, um die Ausführungsidentität zu ändern. Dies erfordert:
  1. Der Servicebenutzer muss die Berechtigung ImpersonateOrgSessions haben
  2. Der Zielbenutzer muss Mitglied der Organisation sein
  3. Der Zielbenutzer muss die Berechtigung UseDevinSessions haben
• Löschen (auf null setzen): Setzt den Zeitplan zurück, sodass er mit dem Standard-Bot-Benutzer ausgeführt wird
• Feld weglassen: Belässt die aktuelle Ausführungsidentität unverändert

Autorisierungen

Authorization · string · header · erforderlich

Anmeldedaten für Service-Benutzer (Präfix: cog_)

Pfadparameter

schedule_id · string · erforderlich

Zeitplan-ID (Präfix: sched-)

Beispiel:

"sched-abc123def456"

Body

application/json

agent · enum<string> | null

Verfügbare Optionen: 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

Verfügbare Optionen: always, failure, never

platform · string | null

VM-Plattform für Sitzungen, die durch diesen Zeitplan gestartet werden (z. B. „windows“). Wenn sie weggelassen wird, bleibt die Plattform unverändert. Der Wert muss mit einer für die Organisation konfigurierten Plattform übereinstimmen (Groß-/Kleinschreibung wird nicht beachtet); unbekannte Werte werden mit einem 400-Fehler abgelehnt, der die verfügbaren Plattformbezeichnungen auflistet.

playbook_id · string | null

prompt · string | null

run_as_user_id · string | null

Legt die Nutzer-ID fest, unter der dieser Zeitplan ausgeführt wird. Erfordert die Berechtigung ImpersonateOrgSessions. Wenn der Wert auf null gesetzt wird, wird wieder der Standard-Bot-Nutzer verwendet. Wird das Feld weggelassen, bleibt die aktuelle Identität unverändert.

schedule_type · enum<string> | null

Verfügbare Optionen: 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

Antwort

200

application/json

Erfolgreiche Antwort

agent · enum<string> · erforderlich

Verfügbare Optionen: devin, data_analyst

consecutive_failures · integer · erforderlich

created_at · string<date-time> · erforderlich

created_by · string | null · erforderlich

enabled · boolean · erforderlich

frequency · string | null · erforderlich

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

last_error_message · string | null · erforderlich

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

name · string · erforderlich

notify_on · enum<string> · erforderlich

Verfügbare Optionen: always, failure, never

org_id · string · erforderlich

playbook · PlaybookInfo · object · erforderlich

Show child attributes

prompt · string · erforderlich

scheduled_session_id · string · erforderlich

updated_at · string<date-time> · erforderlich

bypass_approval · boolean · Standard: false

interval_count · integer · Standard: 1

last_edited_by · string | null

platform · string | null

schedule_type · enum<string> · Standard: recurring

Verfügbare Optionen: 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