Zum Hauptinhalt springen
POST
/
v1
/
schedules
Zeitplan erstellen
curl --request POST \
  --url https://api.olostep.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "endpoint": "<string>",
  "payload": {},
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "text": "<string>"
}
'
{
  "id": "<string>",
  "type": "recurring",
  "method": "GET",
  "endpoint": "<string>",
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Body

application/json
​
method
enum<string>
erforderlich

HTTP-Methode für den geplanten API-Aufruf. Muss entweder GET oder POST sein.

Verfügbare Optionen:
GET,
POST
​
endpoint
string
erforderlich

Die Endpunkt-URL, die aufgerufen wird, wenn der Zeitplan ausgeführt wird. Für POST-Anfragen mit Olostep-Endpunkten kannst du die Kurzform verwenden (z.B. 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers'), die automatisch mit 'https://api.olostep.com/' vorangestellt wird. Für andere Endpunkte gib die vollständige URL an.

​
payload
object

Die Nutzlast, die mit dem API-Aufruf gesendet wird. Kann jede benötigte JSON-Struktur enthalten. Für GET-Anfragen ist dies typischerweise leer. Für POST-Anfragen sollte dies die Daten enthalten, die du an den Endpunkt senden möchtest.

​
cron_expression
string

Cron-Ausdruck im 6-Felder-Format (Minute Stunde Tag Monat Wochentag Jahr) für wiederkehrende Zeitpläne. Erforderlich für wiederkehrende Zeitpläne. Schließt sich gegenseitig mit execute_at und text aus.

​
execute_at
string<date-time>

ISO 8601-Datetime-String für die einmalige Ausführung des Zeitplans. Muss ein gültiges zukünftiges Datum sein. Erforderlich für einmalige Zeitpläne. Schließt sich gegenseitig mit cron_expression aus.

​
expression_timezone
string

IANA-Zeitzonenkennung (z.B. 'UTC', 'America/New_York', 'Europe/London') für den Zeitplan. Erforderlich für wiederkehrende Zeitpläne, optional für einmalige Zeitpläne. Bei Verwendung von natürlichem Sprachtext wird standardmäßig 'UTC' verwendet.

​
text
string

Natürlicher Sprachtext, um automatisch einen Cron-Ausdruck zu generieren. Das System wandelt deinen Text in einen gültigen Cron-Ausdruck um. Beispiele: 'alle 3 Minuten', 'jeden Tag um 10 Uhr', 'jeden Montag um 9 Uhr'. Schließt sich gegenseitig mit cron_expression und execute_at aus. Bei Verwendung wird expression_timezone standardmäßig auf 'UTC' gesetzt.

Antwort

Zeitplan erfolgreich erstellt.

​
id
string

Eindeutige Zeitplankennung

​
type
enum<string>

Art des Zeitplans: 'recurring' für cron-basierte Zeitpläne, 'onetime' für einmalige Ausführungszeitpläne

Verfügbare Optionen:
recurring,
onetime
​
method
enum<string>

HTTP-Methode für den geplanten Aufruf

Verfügbare Optionen:
GET,
POST
​
endpoint
string

Die Endpunkt-URL, die aufgerufen wird

​
cron_expression
string

Cron-Ausdruck (nur bei wiederkehrenden Zeitplänen vorhanden)

​
execute_at
string<date-time>

Ausführungsdatum und -zeit (nur bei einmaligen Zeitplänen vorhanden)

​
expression_timezone
string

Zeitzone für den Zeitplan

​
created
string<date-time>

ISO 8601-Datetime, wann der Zeitplan erstellt wurde