Vai al contenuto principale
POST
/
v1
/
schedules
Crea Orario
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"
}

Autorizzazioni

​
Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
​
method
enum<string>
obbligatorio

Metodo HTTP per la chiamata API programmata. Deve essere GET o POST.

Opzioni disponibili:
GET,
POST
​
endpoint
string
obbligatorio

L'URL dell'endpoint da chiamare quando l'orario viene eseguito. Per le richieste POST con endpoint Olostep, puoi usare la forma breve (es. 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers') che verrà automaticamente prefissata con 'https://api.olostep.com/'. Per altri endpoint, fornisci l'URL completo.

​
payload
object

Il payload da inviare con la chiamata API. Può contenere qualsiasi struttura JSON di cui hai bisogno. Per le richieste GET, questo è tipicamente vuoto. Per le richieste POST, questo dovrebbe contenere i dati che vuoi inviare all'endpoint.

​
cron_expression
string

Espressione cron nel formato a 6 campi (minuto ora giorno mese giorno-della-settimana anno) per orari ricorrenti. Necessaria per orari ricorrenti. Mutuamente esclusiva con execute_at e text.

​
execute_at
string<date-time>

Stringa datetime ISO 8601 per l'esecuzione di un orario una tantum. Deve essere un datetime futuro valido. Necessaria per orari una tantum. Mutuamente esclusiva con cron_expression.

​
expression_timezone
string

Identificatore del fuso orario IANA (es. 'UTC', 'America/New_York', 'Europe/London') per l'orario. Necessario per orari ricorrenti, opzionale per orari una tantum. Quando si usa testo in linguaggio naturale, questo predefinisce 'UTC'.

​
text
string

Testo in linguaggio naturale per generare automaticamente un'espressione cron. Il sistema convertirà il tuo testo in un'espressione cron valida. Esempi: 'ogni 3 minuti', 'ogni giorno alle 10am', 'ogni lunedì alle 9am'. Mutuamente esclusivo con cron_expression e execute_at. Quando usato, expression_timezone predefinisce 'UTC'.

Risposta

Orario creato con successo.

​
id
string

Identificatore unico dell'orario

​
type
enum<string>

Tipo di orario: 'recurring' per orari basati su cron, 'onetime' per orari di esecuzione singola

Opzioni disponibili:
recurring,
onetime
​
method
enum<string>

Metodo HTTP per la chiamata programmata

Opzioni disponibili:
GET,
POST
​
endpoint
string

L'URL dell'endpoint che verrà chiamato

​
cron_expression
string

Espressione cron (presente solo per orari ricorrenti)

​
execute_at
string<date-time>

Datetime di esecuzione (presente solo per orari una tantum)

​
expression_timezone
string

Fuso orario per l'orario

​
created
string<date-time>

Datetime ISO 8601 quando l'orario è stato creato