resultaten
Een resultaat is een record met gegevens of een bestand dat is gepubliceerd naar een opslagbunker. Het bevat de informatie die nodig is om deze gegevens op te halen uit de opslaglocatie.
attributen
naam | type | Omschrijving |
---|---|---|
id | resultaat ID | Bron-ID. |
resource | string, altijd result | Specificatie middelenbron. |
organisation | organisatie ID | De organisatie die aan deze resource is gekoppeld. |
poll | poll ID | De peiling waaraan het resultaat is gekoppeld. |
task | taak ID | De taak waaraan het resultaat is gekoppeld. |
identifier | draad | Een ID voor de inhoud van de gepubliceerde gegevens. |
url | draad | De opslagconfiguratie-URL waarnaar dit resultaat is gepubliceerd. |
type | optionele string | Het bestandstype, indien identificeerbaar. |
checksum | draad | De md5-controlesom van de opgeslagen gegevens. |
size | int | De grootte van de gepubliceerde gegevens, in bytes. |
signed_url | optioneel woordenboek | Ingevuld met ondertekende URL-details indien ingeschakeld op de opslagconfiguratie die in gebruik is. |
state | draad | Een van: available , consumed , expired . |
date_created | datum Tijd | Wanneer de resource is gemaakt. |
date_consumed | datum Tijd | Wanneer het resultaat werd herkend als verbruikt. |
date_deleted | datum Tijd | Wanneer het resultaat door de API uit de opslaglocatie is verwijderd. |
Ondertekende URL's
Als het genereren van ondertekende URL's is ingeschakeld in de opslagconfiguratie die is gebruikt om het resultaat te publiceren, wordt signed_url
ingesteld op een woordenboek met de indeling:
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
Het kenmerk date_expires
geeft aan wanneer de ondertekende URL niet meer geldig is. Na deze datum wordt het kenmerk signed_url
het resultaat ingesteld op null
.
Zie meer details over het configureren van ondertekende URL's in de opslagconfiguratiedocumenten .
Staten
-
available
- Het resultaat kan worden gedownload vanuit de bucket.
-
consumed
- Het resultaat is gedownload en de API is geïnformeerd.
-
expired
- Het resultaat is uit de bucket verwijderd door een geplande opschoning. Deze status is niet van toepassing op door klanten beheerde buckets.
Ophalen GET /results/{result ID}
CURL gebruiken
curl https://ricloud-api.reincubate.com/results/<result ID> \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud results = ricloud.Result.retrieve(<result ID>)
Lijst GET /results
Resultaten in de consumed
of expired
staten consumed
standaard niet in de lijst weergegeven.
parameters
naam | type | Omschrijving |
---|---|---|
poll | poll ID | Filter op de bijbehorende peiling. |
task | taak-ID | Filteren op de bijbehorende taak. |
identifier | draad | Filteren op de resultaat-ID. |
checksum | draad | Filter op de resultaatcontrolesom. |
state | draad | Filter op de resultaatstatus. |
date_created | datetime filter | Filteren op wanneer de bron is gemaakt. |
date_consumed | datetime filter | Filter op wanneer het resultaat werd gemarkeerd als verbruikt. |
date_deleted | datetime filter | Filteren op wanneer het resultaat werd gemarkeerd als verwijderd. |
CURL gebruiken
curl https://ricloud-api.reincubate.com/results \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud results = ricloud.Result.list()
Bevestig POST /results/{result ID}/ack
Erken het resultaat als zijnde geconsumeerd.
CURL gebruiken
curl https://ricloud-api.reincubate.com/results/<result ID>/ack \ -X POST \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud result = ricloud.Result.acknowledge_with_id(<result ID>) # OR result = ricloud.Result.retrieve(<result ID>) result.acknowledge()
Batch bevestig POST /results/ack
Erken dat een reeks resultaten is verbruikt.
Het eindpunt geeft geen foutmelding als een van de opgegeven resultaten al is bevestigd of niet kan worden gevonden.
naam | type | Beschrijving |
---|---|---|
ids | lijst met resultaat-ID's | Een lijst met ID's van de te bevestigen resultaten. |
CURL gebruiken
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
- Voegt het kenmerk
signed_url
toe aan het resultaatobject. Dit is een genest woordenboek dat de ondertekende URL in heturl
kenmerk bevat en wanneer het vervalt indate_expires
. - Voegt de mogelijkheid toe om resultaten in batches te erkennen met het nieuwe
POST /results/ack
eindpunt.