结果
更新
结果是已发布到存储桶的数据或文件的记录。它包含从其存储位置检索此数据所需的信息。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
id | 结果ID | 资源标识符。 |
resource | 字符串，总是result | 资源类型说明符。 |
organisation | 组织ID | 与此资源关联的组织。 |
poll | 投票ID | 结果与之关联的轮询。 |
task | 任务ID | 结果与之相关的任务。 |
identifier | 串 | 已发布数据内容的标识符。 |
url | 串 | 存储配置URL此结果已发布到。 |
type | 可选字符串 | 文件类型（如果可识别）。 |
checksum | 串 | 存储数据的md5校验和。 |
size | INT | 已发布数据的大小（以字节为单位）。 |
signed_url | 可选字典 | 如果在使用中的存储配置上启用，则使用签名的URL详细信息填充。 |
state | 串 | 其中之一： available ，已consumed ， expired 。 |
date_created | 约会时间 | 资源创建时。 |
date_consumed | 约会时间 | 当结果被确认为已消耗时。 |
date_deleted | 约会时间 | 当API从存储位置删除结果时。 |
签名网址
如果在用于发布结果的存储配置上启用了签名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 | 任务ID | 按关联的任务过滤。 |
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 | 结果ID列表 | 要确认的结果ID列表。 |
使用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端点增加了批量确认结果的功能。
