Compiti

Un'attività è responsabile dell'esecuzione di tutti i carichi di lavoro asincroni sull'API, ad esempio stabilendo una sessione con servizi esterni e recuperando ed elaborando i dati.

Le attività sono più comunemente create come parte della creazione di una risorsa di sessione o durante l'esecuzione di un sondaggio.

Qualsiasi dato restituito da un'attività è descritto da qualsiasi risorsa di risultato associata.

Alcune attività, principalmente coinvolte nella gestione di sistemi e organizzazioni, potrebbero non essere rivolte a un utente, a una sorgente oa una sessione o essere associate a un sondaggio. Esempi di questo tipo di attività sono le attività di test di storage e di configurazione webhook.

attributi

Tipi di fonte

Se l'attività è associata a un'origine, il tipo di origine verrà denormalizzato source_type task source_type . Questo aiuta a semplificare le query per le attività di un certo tipo.

tipi

Il tipo di attività è una breve lumaca che identifica l'attività sottostante eseguita all'interno dell'API.

Se l'attività si riferisce all'attività contro una risorsa, come testare una configurazione di webhook, sarà formattata come webhook_config.test .

Se l'attività ha come target un'origine specifica, l'attributo source_type memorizzerà le informazioni relative all'origine, mentre l'attributo type memorizza solo l'azione principale. Ad esempio, la creazione di una sessione attiverà un'attività session.init da creare su una fonte di tipo icloud.account .

Bersaglio

Specifica la destinazione dell'attività sottostante e non è sempre impostata. Ad esempio, l'obiettivo di un webhook_config.test sarà l'ID della configurazione di webhook da testare. Per un'attività di data rispetto a icloud.account tipo icloud.account , sarà il tipo di dati da recuperare come messages.whatsapp .

Stato

• pending l'attività sia stata creata ma è attualmente in attesa in coda.
• processing dell'attività viene eseguita da un lavoratore API.
• suspended l'attività è in attesa del completamento delle attività di blocco prima di procedere.
• succeeded l'attività completata senza errori.
• failed il task ha riscontrato errori.

Errori

Se l'attività ha dei problemi durante l'elaborazione, questo campo verrà impostato con il codice dell'errore incontrato.

changelog

2020/02/20

• Maggiore L'attributo dei results dell'oggetto task è ora un oggetto elenco nidificato, anziché un semplice attributo elenco.

2019/10/16

• L'attributo state dell'oggetto task ora può avere il valore suspended . Ciò indica che l'API è in attesa di completamento delle azioni dell'applicazione Reincubate Relay, come un caricamento di file o un aggiornamento dei metadati, affinché possa riprendere e completare l'attività.

Recupera GET /tasks/{task ID}

Utilizzando cURL

curl https://ricloud-api.reincubate.com/tasks/<task ID> \
  -H 'Authorization: Token <your key_token>'

Usando ricloud-py

import ricloud

task = ricloud.Task.retrieve(<task ID>)

Risposta del campione

{
  "id": "00000001-1234-1234-1234-9876543210",
  "resource": "task",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "00000002-1234-1234-1234-9876543210",
  "poll": "00000003-1234-1234-1234-9876543210",
  "source_type": "mocks.mock",
  "type": "info",
  "target": null,
  "results": {
    "data": [],
    "has_more": false,
    "total_count": 1,
    "url": "/tasks/00000001-1234-1234-1234-9876543210/results"
  },
  "state": "processing",
  "error": null,
  "date_created": "2020-02-20T11:59:15.110451Z",
  "date_started": "2020-02-20T11:59:15.207932Z",
  "date_completed": null
}

Elenco GET /tasks

parametri

Utilizzando cURL

curl https://ricloud-api.reincubate.com/tasks \
  -H 'Authorization: Token <your key_token>'

Usando ricloud-py

import ricloud

tasks = ricloud.Task.list()