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 '
{
  "endpoint": "<string>",
  "payload": {},
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "text": "<string>"
}
'
import requests

url = "https://api.olostep.com/v1/schedules"

payload = {
"endpoint": "<string>",
"payload": {},
"cron_expression": "<string>",
"execute_at": "2023-11-07T05:31:56Z",
"expression_timezone": "<string>",
"text": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpoint: '<string>',
payload: {},
cron_expression: '<string>',
execute_at: '2023-11-07T05:31:56Z',
expression_timezone: '<string>',
text: '<string>'
})
};

fetch('https://api.olostep.com/v1/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.olostep.com/v1/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'endpoint' => '<string>',
'payload' => [

],
'cron_expression' => '<string>',
'execute_at' => '2023-11-07T05:31:56Z',
'expression_timezone' => '<string>',
'text' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.olostep.com/v1/schedules"

payload := strings.NewReader("{\n \"endpoint\": \"<string>\",\n \"payload\": {},\n \"cron_expression\": \"<string>\",\n \"execute_at\": \"2023-11-07T05:31:56Z\",\n \"expression_timezone\": \"<string>\",\n \"text\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.olostep.com/v1/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endpoint\": \"<string>\",\n \"payload\": {},\n \"cron_expression\": \"<string>\",\n \"execute_at\": \"2023-11-07T05:31:56Z\",\n \"expression_timezone\": \"<string>\",\n \"text\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.olostep.com/v1/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endpoint\": \"<string>\",\n \"payload\": {},\n \"cron_expression\": \"<string>\",\n \"execute_at\": \"2023-11-07T05:31:56Z\",\n \"expression_timezone\": \"<string>\",\n \"text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "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. Bei GET-Anfragen ist dies typischerweise leer. Bei 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 -uhrzeit (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