結果
結果は、ストレージバケットに公開されたデータまたはファイルのレコードです。それはその格納場所からこのデータを検索するのに必要な情報を含みます。
属性
名 | タイプ | 説明 |
---|---|---|
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
結果の公開に使用されるストレージ構成で署名付きURL生成が有効になっている場合、 signed_url
は次の形式の辞書に設定されます。
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
date_expires
属性は、署名付きURLがいつ無効になるかを示します。この日付以降、結果のsigned_url
属性はnull
に設定され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
エンドポイントを使用して、結果をバッチで確認する機能を追加します。