Опросы

Ресурс опроса содержит информацию о конкретном запросе данных. После создания опроса он инициирует создание одной или нескольких задач для выполнения запроса.

Атрибуты

Задачи

Самая важная роль ресурса опроса состоит в том, чтобы отразить ход выполнения связанных с ним задач и позволить конечному пользователю начать получать результаты из них, как только они станут доступны. Поэтому ресурс опроса предоставляет атрибуты, связанные с задачей, в которых связанные задачи классифицируются по их состоянию.

Результаты

Any results published by tasks running within the poll are surfaced in the poll's results attribute. This allows for consumption of results before the poll has completed.

ошибки

Any errors raised by tasks running within the poll will appear in the poll's errors attribute.

состояния

Состояние опроса отражает только то, ожидает ли инициализация ( pending ), находится в процессе ( processing ) или все задачи завершены ( completed ).

Опрос не отражает никаких состояний ошибок, кроме как через связанные с ним задачи.

полезная нагрузка

Полезная нагрузка опроса указывает, какие типы информации, типы данных и файлы должны работать для извлечения. Схема атрибута полезной нагрузки опроса описана ниже.

Например, полезная нагрузка опроса для извлечения всех типов информации из источника учетной записи iCloud будет выглядеть так:

{
  "info_types": ["*"]
}

Чтобы получить различные данные для обмена сообщениями из резервной копии iCloud или источника Reincubate Relay, но только с определенной даты:

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

Чтобы получить данные файла для изображений, на которые есть ссылки в библиотеке фотографий iCloud:

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

Различные атрибуты также могут использоваться одновременно:

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

Создать POST /polls

Создайте опрос для данных против определенного сеанса.

The source parameter should only be used when targeting a child source of the session's primary source. For example, if retrieving data from a rirelay.source the source parameter should be the ID of that source.

Использование 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": ["*"]
  }
}'

Использование ricloud-py

import ricloud

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

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

Образец ответа

{
  "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
}

Получить GET /polls/{poll ID}

Использование cURL

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

Использование ricloud-py

import ricloud

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

Список GET /polls

Использование cURL

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

Использование ricloud-py

import ricloud

polls = ricloud.Poll.list()

Изменения

2020-05-05

• The errors attribute was added to the poll object. This is a nested list object containing error objects associated with the poll.

2020-02-20

• Важнейший : атрибут results объекта опроса теперь является вложенным списком, а не простым списком. Это позволяет разбивать результаты на страницы, когда опрос публикует большое количество результатов.

2019-10-16

• Добавляет атрибут subscription в объект опроса, чтобы указать, был ли опрос инициирован подпиской.

2019-06-01

• Атрибут payload объекта опроса теперь может состоять из нескольких типов операций. Это означает, что опрос может быть создан с любым или всеми info-types data-types и files в полезной нагрузке.
• Major Атрибут type в объекте poll устарел в пользу составных полезных нагрузок опроса.