Ergebnisse
Ein Ergebnis ist ein Datensatz oder eine Datei, die in einem Speicher-Bucket veröffentlicht wurde. Es enthält die Informationen, die zum Abrufen dieser Daten vom Speicherort erforderlich sind.
Attribute
Name | Art | Beschreibung |
---|---|---|
id | Ergebnis ID | Ressourcenkennung. |
resource | Zeichenfolge, immer result | Ressourcentypbezeichner. |
organisation | Organisations-ID | Die Organisation, die dieser Ressource zugeordnet ist. |
poll | Umfrage-ID | Die Umfrage, mit der das Ergebnis verknüpft ist. |
task | Aufgaben-ID | Die Aufgabe, der das Ergebnis zugeordnet ist. |
identifier | Zeichenfolge | Eine Kennung für den Inhalt der veröffentlichten Daten. |
url | Zeichenfolge | Die Speicherkonfigurations-URL, in der dieses Ergebnis veröffentlicht wurde. |
type | optionale Zeichenfolge | Der Dateityp, falls erkennbar. |
checksum | Zeichenfolge | Die md5-Prüfsumme der gespeicherten Daten. |
size | int | Die Größe der veröffentlichten Daten in Byte. |
signed_url | optionales Wörterbuch | Wird mit signierten URL-Details gefüllt, sofern diese in der verwendeten Speicherkonfiguration aktiviert sind. |
state | Zeichenfolge | Eines von: available , consumed , expired . |
date_created | Terminzeit | Wann wurde die Ressource erstellt. |
date_consumed | Terminzeit | Wann wurde das Ergebnis als verbraucht anerkannt? |
date_deleted | Terminzeit | Wann das Ergebnis von der API aus dem Speicherort entfernt wurde. |
Signierte URLs
Wenn die Generierung signierter signed_url
in der Speicherkonfiguration aktiviert ist, die zum Veröffentlichen des Ergebnisses verwendet wird, wird die signierte URL auf ein Wörterbuch mit dem folgenden Format festgelegt:
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
Das Attribut date_expires
gibt an, wann die signierte URL nicht mehr gültig ist. Nach diesem Datum wird das signed_url
Attribut des Ergebnisses auf null
.
Weitere Informationen zum Konfigurieren signierter URLs finden Sie in den Speicherkonfigurationsdokumenten .
Zustände
-
available
- Das Ergebnis kann jetzt aus dem Bucket heruntergeladen werden.
-
consumed
- Das Ergebnis wurde heruntergeladen und die API wurde informiert.
-
expired
- Das Ergebnis wurde durch eine geplante Bereinigung aus dem Bucket gelöscht. Dieser Status gilt nicht für kundeneigene Buckets.
GET /results/{result ID}
CURL verwenden
curl https://ricloud-api.reincubate.com/results/<result ID> \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud results = ricloud.Result.retrieve(<result ID>)
Liste GET /results
Ergebnisse in den Status " consumed
oder " expired
werden standardmäßig nicht in der Liste angezeigt.
Parameter
Name | Art | Beschreibung |
---|---|---|
poll | Umfrage-ID | Filtern Sie nach der zugehörigen Umfrage. |
task | Aufgaben-ID | Filtern Sie nach der zugeordneten Aufgabe. |
identifier | Zeichenfolge | Filtern Sie nach der Ergebniskennung. |
checksum | Zeichenfolge | Filtern Sie nach der Ergebnisprüfsumme. |
state | Zeichenfolge | Filtern Sie nach dem Ergebnisstatus. |
date_created | Datum / Uhrzeit-Filter | Filtern nach dem Zeitpunkt, zu dem die Ressource erstellt wurde. |
date_consumed | Datum / Uhrzeit-Filter | Filtern nach, wann das Ergebnis als verbraucht markiert wurde. |
date_deleted | Datum / Uhrzeit-Filter | Filtern nach, wann das Ergebnis als gelöscht markiert wurde. |
CURL verwenden
curl https://ricloud-api.reincubate.com/results \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud results = ricloud.Result.list()
Bestätigen Sie POST /results/{result ID}/ack
Bestätigen Sie das Ergebnis als verbraucht.
CURL verwenden
curl https://ricloud-api.reincubate.com/results/<result ID>/ack \ -X POST \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud result = ricloud.Result.acknowledge_with_id(<result ID>) # OR result = ricloud.Result.retrieve(<result ID>) result.acknowledge()
Batch-Bestätigung POST /results/ack
Bestätigen Sie, dass eine Reihe von Ergebnissen verbraucht wurde.
Der Endpunkt löst keinen Fehler aus, wenn eines der angegebenen Ergebnisse bereits bestätigt wurde oder nicht gefunden werden kann.
Name | Art | Beschreibung |
---|---|---|
ids | Liste der Ergebnis-IDs | Eine Liste der IDs der zu bestätigenden Ergebnisse. |
CURL verwenden
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>"] }'
Änderungsprotokoll
2020-02-27
- Fügt dem
signed_url
Attributsigned_url
. Dies ist ein verschachteltes Wörterbuch, das die signierte URL imurl
Attribut enthält und deren Ablauf indate_expires
abläuft. - Fügt die Möglichkeit hinzu, Ergebnisse in Stapeln mit dem neuen
POST /results/ack
Endpunkt zu bestätigen.