Centro

Un recurso de encuesta contiene información sobre una solicitud específica de datos. Una vez que se crea una encuesta, se activará la creación de una o más tareas para completar la solicitud.

Atributos

Tareas

El papel más importante del recurso de la encuesta es reflejar el progreso de sus tareas asociadas y permitir que el usuario final comience a obtener resultados de estas tan pronto como estén disponibles. Por lo tanto, el recurso de sondeo expone atributos relacionados con la tarea en los que las tareas asociadas se clasifican por su estado.

Resultados

Los resultados publicados por las tareas que se ejecutan dentro de la encuesta aparecen en el atributo de results la encuesta. Esto permite el consumo de resultados antes de que se complete la encuesta.

Los errores

Cualquier error generado por las tareas que se ejecutan dentro de la encuesta aparecerá en el atributo de errors la encuesta.

Estados

El estado de un sondeo refleja solo si el sondeo está en espera de inicialización ( pending ), está en progreso ( processing ) o si todas las tareas han finalizado su ejecución ( completed ).

Una encuesta no refleja ningún estado de error que no sea a través de sus tareas asociadas.

Carga útil

La carga útil de la encuesta indica qué tipos de información, tipos de datos y archivos debería funcionar para recuperar. El esquema del atributo de carga útil de la encuesta se describe a continuación.

Por ejemplo, la carga útil de la encuesta para recuperar todo tipo de información en una fuente de cuenta de iCloud sería:

{
  "info_types": ["*"]
}

Para recuperar una variedad de datos de mensajería de una fuente de copia de seguridad de iCloud o Reincubate Relay, pero solo desde una fecha determinada:

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

Para recuperar datos de archivo para imágenes a las que se hace referencia en un resultado de iCloud Photo Library:

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

Los diferentes atributos también se pueden usar simultáneamente:

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

Crear POST /polls

Crear una encuesta para los datos contra una sesión específica.

El parámetro source solo debe usarse cuando se dirige a una fuente secundaria de la fuente primaria de la sesión. Por ejemplo, si recupera datos de un rirelay.source el parámetro source debe ser el ID de esa fuente.

Usando 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": ["*"]
  }
}'

Utilizando ricloud-py

import ricloud

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

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

Respuesta de muestra

{
  "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"
  },
  "errors": {
    "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/errors"
  },
  "state": "pending",
  "date_created": "2020-02-20T11:59:14.694337Z",
  "date_started": null,
  "date_completed": null
}

Recuperar GET /polls/{poll ID}

Usando cURL

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

Utilizando ricloud-py

import ricloud

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

Lista GET /polls

Usando cURL

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

Utilizando ricloud-py

import ricloud

polls = ricloud.Poll.list()

Registro de cambios

2020-05-05

• El atributo de errors se agregó al objeto de encuesta. Este es un objeto de lista anidada que contiene objetos de error asociados con la encuesta.

2020-02-20

• Mayor : el atributo de results del objeto de encuesta ahora es un objeto de lista anidada, en lugar de un simple atributo de lista. Esto hace posible paginar resultados cuando una encuesta publica una gran cantidad de resultados.

2019-10-16

• Agrega el atributo de subscription al objeto de encuesta para indicar si la encuesta fue activada por una suscripción.

2019-06-01

• El atributo de payload objeto de encuesta ahora puede estar compuesto por múltiples tipos de operaciones. Esto significa que se puede crear una encuesta con cualquiera o todos info-types de info-types data-types y files en la carga útil.
• Mayor El atributo de type en el objeto de encuesta está en desuso a favor de las cargas útiles de encuesta componibles.