Results

A result is a record of data or a file that has been published to a storage bucket. It contains the information necessary to retrieve this data from its storage location.

Attributes

Signed URLs

If signed URL generation is enabled on the storage config used to publish the result, the signed_url will be set to a dictionary with the format:

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

The date_expires attribute indicates when the signed URL will cease to be valid. After this date, the result's signed_url attribute will be set to null.

See more details on configuring signed URLs in the storage config docs.

States

available

The result is ready to be downloaded from the bucket.

consumed

The result has been downloaded and the API has been informed.

expired

The result has been deleted from the bucket by a scheduled cleanup. This state does not apply to client-owned buckets.

Retrieve GET /results/{result ID}

Using cURL

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

Using ricloud-py

import ricloud

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

List GET /results

Results in the states consumed or expired do not appear in the list by default.

Parameters

Using cURL

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

Using ricloud-py

import ricloud

results = ricloud.Result.list()

Acknowledge POST /results/{result ID}/ack

Acknowledge the result as having been consumed.

Using cURL

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

Using ricloud-py

import ricloud

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

# OR

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

result.acknowledge()

Batch acknowledge POST /results/ack

Acknowledge a batch of results as having been consumed.

The endpoint will not raise an error if any of the specified results have already been acknowledged or cannot be found.

Using 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>"]
}'

Changelog

2020-02-27

• Adds the signed_url attribute to the result object. This is a nested dictionary containing the signed URL in the url attribute and when it expires in date_expires.
• Adds the ability to acknowledge results in batches with the new POST /results/ack endpoint.