Результаты

обновленный более недели назад

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

Атрибуты

название	тип	описание
`id`	ID результата	Идентификатор ресурса.
`resource`	строка, всегда `result`	Спецификатор типа ресурса.
`organisation`	идентификатор организации	Организация, связанная с этим ресурсом.
`poll`	ID опроса	Опрос, с которым связан результат.
`task`	идентификатор задачи	Задача, с которой связан результат.
`identifier`	строка	Идентификатор содержания опубликованных данных.
`url`	строка	URL конфигурации хранилища, к которому был опубликован этот результат.
`type`	необязательная строка	Тип файла, если его можно идентифицировать.
`checksum`	строка	Контрольная сумма md5 сохраненных данных.
`size`	ИНТ	Размер публикуемых данных в байтах.
`signed_url`	дополнительный словарь	Заполняется подписанным URL-адресом, если он включен в используемой конфигурации хранилища.
`state`	строка	Один из: `available` , `consumed` , `expired` .
`date_created`	Дата и время	Когда ресурс был создан.
`date_consumed`	Дата и время	Когда результат был признан потребленным.
`date_deleted`	Дата и время	Когда результат был удален из хранилища с помощью API.

Подписанные URL

Если в конфигурации хранилища, используемой для публикации результата, включена генерация подписанного URL, для signed_url будет задан словарь в формате:

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

date_expires указывает, когда подписанный URL перестанет быть действительным. После этой даты для атрибута signed_url результата будет установлено значение null .

Подробнее о настройке подписанных URL-адресов см. В документации по настройке хранилища .

состояния

available: Результат готов к загрузке из корзины.
consumed: Результат был загружен, и API был проинформирован.
expired: Результат был удален из корзины путем запланированной очистки. Это состояние не относится к клиентским сегментам.

Получить `GET /results/{result ID}`

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

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

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

import ricloud

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

Список `GET /results`

Результаты в штатах consumed или expired , не отображаются в списке по умолчанию.

параметры

название	тип	описание
`poll`	ID опроса	Фильтровать по связанному опросу.
`task`	идентификатор задачи	Фильтровать по связанной задаче.
`identifier`	строка	Фильтр по идентификатору результата.
`checksum`	строка	Фильтр по контрольной сумме результата.
`state`	строка	Фильтр по состоянию результата.
`date_created`	фильтр даты и времени	Фильтровать по тому, когда ресурс был создан.
`date_consumed`	фильтр даты и времени	Фильтровать по, когда результат был помечен как использованный.
`date_deleted`	фильтр даты и времени	Фильтровать по, когда результат был помечен как удаленный.

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

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

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

import ricloud

results = ricloud.Result.list()

Подтвердить `POST /results/{result ID}/ack`

Подтвердите результат как использованный.

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

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

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

import ricloud

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

# OR

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

result.acknowledge()

Пакетное подтверждение `POST /results/ack` подтверждение

Подтвердите пакет результатов как использованный.

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

имя	тип	описание
`ids`	список идентификаторов результатов	Список идентификаторов результатов, которые должны быть подтверждены.

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

Изменения

2020-02-27

Добавляет атрибут signed_url в объект результата. Это вложенный словарь, содержащий подписанный URL-адрес в атрибуте url и срок его действия в date_expires .
Добавляет возможность подтверждения результатов в пакетах с новой конечной точкой POST /results/ack .

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

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

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

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

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

Атрибуты

Подписанные URL

состояния

Получить GET /results/{result ID}

Список GET /results

Подтвердить POST /results/{result ID}/ack

Пакетное подтверждение POST /results/ack подтверждение

Изменения

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

Получить `GET /results/{result ID}`

Список `GET /results`

Подтвердить `POST /results/{result ID}/ack`

Пакетное подтверждение `POST /results/ack` подтверждение