Опросы

обновленный

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

Атрибуты

название тип описание
id ID опроса Идентификатор ресурса.
resource строка, всегда poll Спецификатор типа ресурса.
organisation идентификатор организации Организация, связанная с этим ресурсом.
key идентификатор ключа Ключ, связанный с этим ресурсом.
user Идентификатор пользователя Пользователь, связанный с этим ресурсом.
source идентификатор источника Источник, на который нацелен опрос. Это может быть дочерним источником источника сеанса.
session идентификатор сессии Сессия, которую использует опрос.
subscription необязательный идентификатор подписки Идентификатор связанного объекта подписки, если применимо.
tasks_pending список идентификаторов задач Задачи, связанные с опросом, ожидающие обработки.
tasks_processing список идентификаторов задач Задачи, связанные с опросом, которые обрабатываются.
tasks_succeeded список идентификаторов задач Задачи, связанные с опросом, которые прошли успешно.
tasks_failed список идентификаторов задач Задачи, связанные с опросом, потерпели неудачу.
tasks_suspended список идентификаторов задач Задачи, связанные с опросом, приостановлены.
results список объектов результатов Список объектов результатов, сгенерированных задачами опроса.
state строка Один из: в pending , processing completed .
date_created Дата и время Когда ресурс был создан.
date_started необязательная дата и время Когда началась обработка опроса.
date_completed необязательная дата и время Когда обработка опроса закончена.

Задачи

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

Результаты

Все результаты, опубликованные задачами, запущенными в опросе, отображаются в атрибуте results опроса.

состояния

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

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

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

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

название тип описание
info_types список объектов типа info_type Определяет, какие типы информации должны быть получены. Поддерживает подстановочный знак * .
data_types список объектов data_type Указывает, какие типы данных должны быть получены.
files список идентификаторов file . Указывает, какие файлы получить.
filters объект вложенных filters Указывает, какие фильтры применять к полученным данным.

Например, полезная нагрузка опроса для извлечения всех типов информации из источника учетной записи 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

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

Поскольку ресурс сеанса уже напрямую связан с конкретным источником, вам не нужно указывать параметр source . Однако можно указать, что опрос предназначен для дочернего источника первичного источника, к которому привязан сеанс. Например, в службе iCloud сеанс может быть создан только с источниками учетных записей iCloud (первичным источником службы iCloud), но вы можете ориентировать данные только из определенной резервной копии iCloud (дочернего источника учетной записи iCloud), указав ее Я БЫ.

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

Использование 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,
)

Получить 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

название тип описание
key идентификатор ключа Фильтр по связанному ключу. Это ключ, используемый пользователем в то время.
user Идентификатор пользователя Фильтровать по связанному пользователю.
source идентификатор источника Фильтр по целевому источнику.
session идентификатор сессии Фильтр по целевой сессии.
subscription идентификатор подписки Фильтр по связанной подписке.
state строка Фильтр по состоянию сеанса.
date_created фильтр даты и времени Фильтровать по тому, когда ресурс был создан.
date_started фильтр даты и времени Фильтровать по, когда опрос начался.
date_completed фильтр даты и времени Фильтровать по окончании опроса.

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

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

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

import ricloud

polls = ricloud.Poll.list()

Как мы можем помочь?

Наша служба поддержки здесь, чтобы помочь!

Наш офис работает с понедельника по пятницу с 9:00 до 17:00 по Гринвичу. Время в настоящее время 7:37 ДП с GMT.

Мы стремимся отвечать на все сообщения в течение одного рабочего дня.

Перейти в раздел поддержки › Связаться с командой предприятия ›
Наша отличная команда поддержки

© 2008 - 2019 Reincubate Ltd. Все права защищены. Зарегистрировано в Англии и Уэльсе #5189175, VAT GB151788978. Reincubate® является зарегистрированным товарным знаком. Защита & Условия. Мы рекомендуем 2FA. Построен с в Лондоне.