Les sondages

Une ressource d'interrogation contient des informations sur une demande spécifique de données. Une fois qu'un sondage est créé, il déclenchera la création d'une ou plusieurs tâches afin de compléter la demande.

Les attributs

Tâches

Le rôle le plus important de la ressource de sondage est de refléter la progression des tâches associées et de permettre à l'utilisateur final de commencer à extraire les résultats de ces tâches dès qu'ils sont disponibles. Par conséquent, la ressource d'interrogation expose les attributs liés aux tâches dans lesquels les tâches associées sont classées en fonction de leur état.

Résultats

Tous les résultats publiés par les tâches exécutées dans le sondage sont surfacés dans l'attribut results du sondage.

États

L'état d'une interrogation indique uniquement si l'interrogation est en attente d'initialisation (en pending ), en cours de processing ( processing ) ou si toutes les tâches ont été exécutées ( completed ).

Une interrogation ne reflète aucun état d'erreur autre que par ses tâches associées.

Charge utile

La charge utile d'interrogation indique les types d'informations, les types de données et les fichiers à récupérer. Le schéma d'attribut d'interrogation de la charge utile est décrit ci-dessous.

Par exemple, le payload d'interrogation permettant de récupérer tous les types d'informations sur une source de compte iCloud serait:

{
  "info_types": ["*"]
}

Pour récupérer diverses données de messagerie à partir d'une source de sauvegarde iCloud ou Reincubate Relay, mais uniquement à partir d'une date donnée:

{
  "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"],
  "filters": {
    "since": "2019-09-15T22:04:12Z"
  }
}

Pour récupérer les données de fichier pour les images référencées dans un résultat iCloud Photo Library:

{
  "files": ["icpl://xyz123", "icpl://abc321"]
}

Les différents attributs peuvent également être utilisés simultanément:

{
  "info_types": ["*"],
  "data_types": ["ios_phone.calls"]
}

Changelog

2020-02-20

• Major : l'attribut results de l'objet poll est désormais un objet liste imbriqué, plutôt qu'un simple attribut list. Cela permet de paginer les résultats lorsqu'un sondage publie un grand nombre de résultats.

2019-10-16

• Ajoute l'attribut d' subscription à l'objet d'interrogation pour indiquer si l'interrogation a été déclenchée par un abonnement.

2019-06-01

• L'attribut de payload objet d'interrogation peut désormais être composé de plusieurs types d'opérations. Cela signifie qu'un sondage peut être créé avec tout ou partie des info-types d' info-types data-types et des files dans la charge utile.
• Majeur L'attribut type sur l'objet d'interrogation est déconseillé au profit des charges utiles d'interrogation composables.

Créer un POST /polls

Créez un sondage pour les données d'une session spécifique.

Comme une ressource de session est déjà directement liée à une source spécifique, vous n’avez pas à fournir le paramètre source . Toutefois, il peut être fourni pour spécifier que le sondage cible une source enfant de la source principale à laquelle la session est liée. Par exemple, sur le service iCloud, une session ne peut être créée que sur des sources de compte iCloud (la source principale du service iCloud), mais vous pouvez cibler des données uniquement à partir d’une sauvegarde iCloud spécifique (source enfant du compte iCloud) en fournissant son ID.

Utiliser cURL

curl https://ricloud-api.reincubate.com/polls \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "payload": {
    "info_types": ["*"]
  }
}'

Utiliser ricloud-py

import ricloud

poll_payload = {
  'info_types': ['*'],
}

poll = ricloud.Poll.create(
  session='<session ID or ricloud.Session instance>',
  payload=poll_payload,
)

Exemple de réponse

{
  "id": "54554389-5f1a-4ccf-9bb8-024a031cf948",
  "resource": "poll",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "f5a7a7ef-ff21-47fe-9aa6-7ebd08123623",
  "subscription": null,
  "tasks_pending": [],
  "tasks_processing": [],
  "tasks_succeeded": [],
  "tasks_failed": [],
  "tasks_suspended": [],
  "results": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/results"
  },
  "state": "pending",
  "date_created": "2020-02-20T11:59:14.694337Z",
  "date_started": null,
  "date_completed": null
}

Récupérer GET /polls/{poll ID}

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

poll = ricloud.Poll.retrieve(<poll ID>)

Liste GET /polls

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

polls = ricloud.Poll.list()