Resultados
Um resultado é um registro de dados ou um arquivo que foi publicado em um intervalo de armazenamento. Ele contém as informações necessárias para recuperar esses dados do seu local de armazenamento.
Atributos
nome | tipo | descrição |
---|---|---|
id | ID do resultado | Identificador de recursos. |
resource | string, sempre result | Especificador de tipo de recurso. |
organisation | ID da organização | A organização associada a esse recurso. |
poll | ID da enquete | A pesquisa à qual o resultado está associado. |
task | ID da tarefa | A tarefa à qual o resultado está associado. |
identifier | corda | Um identificador para o conteúdo dos dados publicados. |
url | corda | O URL de configuração de armazenamento para o qual esse resultado foi publicado. |
type | sequência opcional | O tipo de arquivo, se identificável. |
checksum | corda | A soma de verificação md5 dos dados armazenados. |
size | int | O tamanho dos dados publicados, em bytes. |
signed_url | dicionário opcional | Preenchido com detalhes de URL assinados, se ativado na configuração de armazenamento em uso. |
state | corda | Um de: available , consumed , expired . |
date_created | data hora | Quando o recurso foi criado. |
date_consumed | data hora | Quando o resultado foi reconhecido como consumido. |
date_deleted | data hora | Quando o resultado foi removido do local de armazenamento pela API. |
URLs assinados
Se a geração de URL assinada estiver ativada na configuração de armazenamento usada para publicar o resultado, o signed_url
será definido como um dicionário com o formato:
{ "url": "<signed URL value here>", "date_expires": "2020-02-29T11:59:15.110451Z" }
O atributo date_expires
indica quando o URL assinado deixará de ser válido. Após essa data, o atributo do signed_url
do resultado será definido como null
.
Veja mais detalhes sobre a configuração de URLs assinados nos documentos de configuração de armazenamento .
Estados
-
available
- O resultado está pronto para ser baixado do balde.
-
consumed
- O resultado foi baixado e a API foi informada.
-
expired
- O resultado foi excluído do intervalo por uma limpeza agendada. Este estado não se aplica aos intervalos de propriedade do cliente.
Recuperar GET /results/{result ID}
Usando cURL
curl https://ricloud-api.reincubate.com/results/<result ID> \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud results = ricloud.Result.retrieve(<result ID>)
Listar GET /results
Os resultados nos estados consumed
ou expired
não aparecem na lista por padrão.
Parâmetros
nome | tipo | descrição |
---|---|---|
poll | ID da enquete | Filtrar pela pesquisa associada. |
task | ID da tarefa | Filtrar pela tarefa associada. |
identifier | corda | Filtre pelo identificador de resultados. |
checksum | corda | Filtre pela soma de verificação do resultado. |
state | corda | Filtre pelo estado do resultado. |
date_created | filtro de data e hora | Filtrar por quando o recurso foi criado. |
date_consumed | filtro de data e hora | Filtre por quando o resultado foi marcado como consumido. |
date_deleted | filtro de data e hora | Filtre por quando o resultado foi marcado como excluído. |
Usando cURL
curl https://ricloud-api.reincubate.com/results \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud results = ricloud.Result.list()
Confirmar POST /results/{result ID}/ack
Reconheça o resultado como tendo sido consumido.
Usando cURL
curl https://ricloud-api.reincubate.com/results/<result ID>/ack \ -X POST \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud result = ricloud.Result.acknowledge_with_id(<result ID>) # OR result = ricloud.Result.retrieve(<result ID>) result.acknowledge()
Confirmação em lote POST /results/ack
Reconheça um lote de resultados como tendo sido consumido.
O terminal não gerará um erro se algum dos resultados especificados já tiver sido reconhecido ou não puder ser encontrado.
nome | tipo | descrição |
---|---|---|
ids | lista de IDs de resultado | Uma lista de IDs dos resultados a serem reconhecidos. |
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>"] }'
Changelog
2020-02-27
- Adiciona o
signed_url
atributo para o objeto resultado. Este é um dicionário aninhado que contém a URL assinada no atributourl
e quando expira emdate_expires
. - Adiciona a capacidade de reconhecer resultados em lotes com o novo terminal
POST /results/ack
.