risultati
Un risultato è un record di dati o un file che è stato pubblicato su un bucket di archiviazione. Contiene le informazioni necessarie per recuperare questi dati dalla sua posizione di archiviazione.
attributi
| nome | genere | descrizione |
|---|---|---|
id | ID risultato | Identificatore di risorse |
resource | stringa, sempre result | Specificatore del tipo di risorsa. |
organisation | ID dell'organizzazione | L'organizzazione associata a questa risorsa. |
poll | ID sondaggio | Il sondaggio a cui è associato il risultato. |
task | ID compito | L'attività a cui è associato il risultato. |
identifier | stringa | Un identificatore per il contenuto dei dati pubblicati. |
url | stringa | L'URL di configurazione di archiviazione a cui questo risultato è stato pubblicato. |
type | stringa opzionale | Il tipo di file, se identificabile. |
checksum | stringa | Il checksum MD5 dei dati memorizzati. |
size | int | La dimensione dei dati pubblicati, in byte. |
signed_url | dizionario opzionale | Popolato con i dettagli dell'URL firmato se abilitato nella configurazione di archiviazione in uso. |
state | stringa | Uno di: available , consumed , expired . |
date_created | appuntamento | Quando la risorsa è stata creata. |
date_consumed | appuntamento | Quando il risultato è stato riconosciuto come consumato. |
date_deleted | appuntamento | Quando il risultato è stato rimosso dal percorso di archiviazione dall'API. |
URL firmati
Se la generazione dell'URL con segno è abilitata nella configurazione di archiviazione utilizzata per pubblicare il risultato, signed_url verrà impostato su un dizionario con il formato:
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
L'attributo date_expires indica quando l'URL firmato cesserà di essere valido. Dopo questa data, l'attributo signed_url del risultato verrà impostato su null .
Vedi maggiori dettagli sulla configurazione degli URL firmati nei documenti di configurazione dell'archiviazione .
stati
-
available - Il risultato è pronto per essere scaricato dal secchio.
-
consumed - Il risultato è stato scaricato e l'API è stata informata.
-
expired - Il risultato è stato cancellato dal bucket tramite una pulizia pianificata. Questo stato non si applica ai bucket di proprietà del cliente.
Recupera GET /results/{result ID}
Utilizzando cURL
curl https://ricloud-api.reincubate.com/results/<result ID> \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud results = ricloud.Result.retrieve(<result ID>)
Elenco GET /results
I risultati negli stati consumed o expired non vengono visualizzati nell'elenco per impostazione predefinita.
parametri
| nome | genere | descrizione |
|---|---|---|
poll | ID sondaggio | Filtra per sondaggio associato. |
task | ID attività | Filtra per attività associata. |
identifier | corda | Filtra per identificatore del risultato. |
checksum | corda | Filtra per checksum dei risultati. |
state | corda | Filtra per stato del risultato. |
date_created | filtro datetime | Filtra per quando la risorsa è stata creata. |
date_consumed | filtro datetime | Filtra per quando il risultato è stato contrassegnato come consumato. |
date_deleted | filtro datetime | Filtra per quando il risultato è stato contrassegnato come eliminato. |
Utilizzando cURL
curl https://ricloud-api.reincubate.com/results \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud results = ricloud.Result.list()
Conferma POST /results/{result ID}/ack
Riconoscere il risultato come se fosse stato consumato.
Utilizzando cURL
curl https://ricloud-api.reincubate.com/results/<result ID>/ack \ -X POST \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud result = ricloud.Result.acknowledge_with_id(<result ID>) # OR result = ricloud.Result.retrieve(<result ID>) result.acknowledge()
Lotto conferma POST /results/ack
Riconoscere una serie di risultati come consumati.
L'endpoint non genererà un errore se uno dei risultati specificati è già stato riconosciuto o non può essere trovato.
| nome | genere | descrizione |
|---|---|---|
ids | elenco di ID risultato | Un elenco di ID dei risultati da riconoscere. |
Utilizzando cURL
curl https://ricloud-api.reincubate.com/results/ack \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "ids": ["<result ID>", "<result ID>"] }'
changelog
2020/02/27
- Aggiunge l'attributo
signed_urlall'oggetto risultato. Questo è un dizionario nidificato contenente l'URL firmato nell'attributourle quando scade tradate_expires. - Aggiunge la possibilità di riconoscere i risultati in batch con il nuovo endpoint
POST /results/ack.
