Resultados
Un resultado es un registro de datos o un archivo que se ha publicado en un contenedor de almacenamiento. Contiene la información necesaria para recuperar estos datos desde su ubicación de almacenamiento.
Atributos
nombre | tipo | descripción |
---|---|---|
id | ID de resultado | Identificador de recursos. |
resource | cadena, siempre result | Especificador de tipo de recurso. |
organisation | ID de organización | La organización asociada a este recurso. |
poll | ID de encuesta | La encuesta con la que está asociado el resultado. |
task | ID de tarea | La tarea a la que se asocia el resultado. |
identifier | cuerda | Un identificador para los contenidos de los datos publicados. |
url | cuerda | La configuración de almacenamiento url este resultado fue publicado a. |
type | cadena opcional | El tipo de archivo, si es identificable. |
checksum | cuerda | La suma de comprobación md5 de los datos almacenados. |
size | En t | El tamaño de los datos publicados, en bytes. |
signed_url | diccionario opcional | Rellenado con detalles de URL firmados si está habilitado en la configuración de almacenamiento en uso. |
state | cuerda | Uno de: available , consumed , expired . |
date_created | fecha y hora | Cuando el recurso fue creado. |
date_consumed | fecha y hora | Cuando el resultado fue reconocido como consumido. |
date_deleted | fecha y hora | Cuando el resultado fue eliminado de la ubicación de almacenamiento por la API. |
URL firmadas
Si la generación de URL firmada está habilitada en la configuración de almacenamiento utilizada para publicar el resultado , signed_url
se establecerá en un diccionario con el formato:
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
El atributo date_expires
indica cuándo la URL firmada dejará de ser válida. Después de esta fecha, el resultado de signed_url
atributo se establece en null
.
Consulte más detalles sobre la configuración de URL firmadas en los documentos de configuración de almacenamiento .
Estados
-
available
- El resultado está listo para ser descargado desde el cubo.
-
consumed
- El resultado ha sido descargado y la API ha sido informada.
-
expired
- El resultado se ha eliminado del depósito por una limpieza programada. Este estado no se aplica a los cubos propiedad del cliente.
Recuperar GET /results/{result ID}
Usando cURL
curl https://ricloud-api.reincubate.com/results/<result ID> \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud results = ricloud.Result.retrieve(<result ID>)
Lista GET /results
Los resultados en los estados consumed
o expired
no aparecen en la lista de forma predeterminada.
Parámetros
nombre | tipo | descripción |
---|---|---|
poll | ID de encuesta | Filtrar por la encuesta asociada. |
task | ID de tarea | Filtrar por la tarea asociada. |
identifier | cuerda | Filtrar por el identificador de resultado. |
checksum | cuerda | Filtrar por la suma de comprobación de resultados. |
state | cuerda | Filtrar por el estado del resultado. |
date_created | filtro de fecha y hora | Filtrar por cuando se creó el recurso. |
date_consumed | filtro de fecha y hora | Filtre por cuando el resultado se marcó como consumido. |
date_deleted | filtro de fecha y hora | Filtre por cuando el resultado se marcó como eliminado. |
Usando cURL
curl https://ricloud-api.reincubate.com/results \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud results = ricloud.Result.list()
Confirmar POST /results/{result ID}/ack
Reconoce el resultado como consumido.
Usando cURL
curl https://ricloud-api.reincubate.com/results/<result ID>/ack \ -X POST \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud result = ricloud.Result.acknowledge_with_id(<result ID>) # OR result = ricloud.Result.retrieve(<result ID>) result.acknowledge()
Lote de confirmación POST /results/ack
Reconoce que un lote de resultados se ha consumido.
El punto final no generará un error si alguno de los resultados especificados ya se ha reconocido o no se puede encontrar.
nombre | tipo | descripción |
---|---|---|
ids | lista de ID de resultados | Una lista de ID de los resultados a reconocer. |
Usando 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>"] }'
Registro de cambios
2020-02-27
- Agrega el
signed_url
atributo al objeto de resultado. Este es un diccionario anidado que contiene la URL firmada en el atributourl
y cuando caduca endate_expires
. - Agrega la capacidad de reconocer los resultados en lotes con el nuevo punto final
POST /results/ack
.