Résultats

Mis à jour

Un résultat est un enregistrement de données ou un fichier publié dans un compartiment de stockage. Il contient les informations nécessaires pour extraire ces données de son emplacement de stockage.

Les attributs

prénom type la description
id résultat ID Identifiant de ressource.
resource chaîne, toujours result Spécificateur de type de ressource.
organisation ID d'organisation L'organisation associée à cette ressource.
poll ID de sondage Le sondage auquel le résultat est associé.
task ID de tâche La tâche à laquelle le résultat est associé.
identifier chaîne Un identifiant pour le contenu des données publiées.
url chaîne L'URL de configuration de stockage à laquelle ce résultat a été publié.
type chaîne facultative Le type de fichier, s'il est identifiable.
checksum chaîne La somme de contrôle md5 des données stockées.
size int La taille des données publiées, en octets.
signed_url dictionnaire optionnel Rempli avec les détails de l'URL signée s'il est activé sur la configuration de stockage utilisée.
state chaîne One of: available , consumed , expired .
date_created date / heure Quand la ressource a été créée.
date_consumed date / heure Lorsque le résultat a été reconnu comme consommé.
date_deleted date / heure Lorsque le résultat a été supprimé de l'emplacement de stockage par l'API.

URL signées

Si la génération d'URL signée est activée sur la configuration de stockage utilisée pour publier le résultat, le signed_url sera défini sur un dictionnaire au format:

{
  "url": "<signed URL value here>",
  "date_expires": "2020-02-29T11:59:15.110451Z"
}

L'attribut date_expires indique quand l'URL signée cessera d'être valide. Après cette date, l'attribut signed_url du résultat sera défini sur null .

Voir plus de détails sur la configuration des URL signées dans les documents de configuration de stockage .

États

available
Le résultat est prêt à être téléchargé à partir du compartiment.
consumed
Le résultat a été téléchargé et l'API a été informée.
expired
Le résultat a été supprimé du compartiment par un nettoyage planifié. Cet état ne s'applique pas aux compartiments appartenant au client.

Récupérer GET /results/{result ID}

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

results = ricloud.Result.retrieve(<result ID>)

Liste GET /results

Les résultats dans les états consumed ou expired n'apparaissent pas dans la liste par défaut.

Paramètres

prénom type la description
poll ID de sondage Filtrer par le sondage associé.
task ID de tâche Filtrer par la tâche associée.
identifier chaîne Filtrer par l'identifiant de résultat.
checksum chaîne Filtrer par la somme de contrôle du résultat.
state chaîne Filtrer par l'état du résultat.
date_created filtre datetime Filtrer par date de création de la ressource.
date_consumed filtre datetime Filtrer par quand le résultat a été marqué comme consommé.
date_deleted filtre datetime Filtrer par quand le résultat a été marqué comme supprimé.

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

results = ricloud.Result.list()

Reconnaître POST /results/{result ID}/ack

Reconnaître le résultat comme ayant été consommé.

Utiliser cURL

curl https://ricloud-api.reincubate.com/results/<result ID>/ack \
  -X POST \
  -H 'Authorization: Token <your key_token>'

Utiliser ricloud-py

import ricloud

result = ricloud.Result.acknowledge_with_id(<result ID>)

# OR

result = ricloud.Result.retrieve(<result ID>)

result.acknowledge()

Lot accusé de réception POST /results/ack réception

Reconnaissez qu'un lot de résultats a été consommé.

Le point de terminaison ne déclenchera pas d'erreur si l'un des résultats spécifiés a déjà été acquitté ou est introuvable.

Nom type la description
ids liste des ID de résultat Une liste des identifiants des résultats à reconnaître.

Utiliser 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

  • Ajoute l'attribut signed_url à l'objet résultat. Il s'agit d'un dictionnaire imbriqué contenant l'URL signée dans l'attribut url et lorsqu'il expire dans date_expires .
  • Ajoute la possibilité de reconnaître les résultats par lots avec le nouveau point de terminaison POST /results/ack .

Comment pouvons nous aider?

Notre équipe de support est là pour vous aider!

Nos bureaux sont ouverts du lundi au vendredi, de 9 h à 17 h GMT. L’heure est actuellement 4:57 Après-midi GMT.

Notre objectif est de répondre à tous les messages en un jour ouvrable.

Notre superbe équipe de support

© 2008 - 2024 Reincubate Ltd. Tous droits réservés. Enregistré en Angleterre et au Pays de Galles #5189175, VAT GB151788978. Reincubate® et Camo® sont des marques déposées. Politique de confidentialité & termes.