Pesquisas

Atualizada

Um recurso de pesquisa contém informações sobre uma solicitação específica de dados. Depois que uma pesquisa é criada, ela acionará a criação de uma ou mais tarefas para concluir a solicitação.

Atributos

nome tipo descrição
id ID de pesquisa Identificador de recursos.
resource string, sempre poll Especificador de tipo de recurso.
organisation ID da organização A organização associada a esse recurso.
key ID da chave A chave associada a este recurso.
user ID do usuário O usuário associado a este recurso.
source ID da fonte A fonte que a pesquisa está segmentando. Isso pode ser uma fonte filho da fonte da sessão.
session identificação de sessão A sessão que a enquete está usando.
subscription ID de assinatura opcional O ID do objeto de assinatura associado, se aplicável.
tasks_pending lista de IDs de tarefas As tarefas associadas à pesquisa que estão aguardando processamento.
tasks_processing lista de IDs de tarefas As tarefas associadas à pesquisa que está sendo processada.
tasks_succeeded lista de IDs de tarefas As tarefas associadas à pesquisa que foram bem-sucedidas.
tasks_failed lista de IDs de tarefas As tarefas associadas à pesquisa que falharam.
tasks_suspended lista de IDs de tarefas As tarefas associadas à pesquisa que estão suspensas.
results lista de objetos de resultado Lista de objetos de resultado gerados pelas tarefas da pesquisa.
state corda Um dos seguintes: pending , processing , completed .
date_created data hora Quando o recurso foi criado.
date_started data e hora opcional Quando o processamento da enquete começou.
date_completed data e hora opcional Quando o processamento da enquete terminou.

Tarefas

O papel mais importante do recurso de pesquisa é refletir o progresso de suas tarefas associadas e permitir que o usuário final comece a buscar resultados a partir deles assim que estiverem disponíveis. Portanto, o recurso de pesquisa expõe atributos relacionados à tarefa em que as tarefas associadas são categorizadas por seu estado.

Resultados

Quaisquer resultados publicados por tarefas executadas na enquete são apresentados no atributo de results da enquete.

Estados

O estado de uma pesquisa reflete apenas se a pesquisa está aguardando a inicialização ( pending ), está em andamento ( processing ) ou se todas as tarefas terminaram a execução ( completed ).

Uma enquete não reflete nenhum estado de erro além das tarefas associadas.

Carga útil

A carga útil da pesquisa indica quais tipos de informações, tipos de dados e arquivos devem ser recuperados. O esquema do atributo de carga útil da pesquisa é descrito abaixo.

nome tipo descrição
info_types lista de objetos info_type Especifica quais tipos de informações devem ser recuperados. Suporta curinga * .
data_types lista de objetos data_type Especifica quais tipos de dados devem ser recuperados.
files lista de IDs de file . Especifica quais arquivos recuperar.
filters objeto de filters aninhados Especifica quais filtros aplicar aos dados recuperados.

Por exemplo, a carga útil da pesquisa para recuperar todos os tipos de informações em uma fonte de conta do iCloud seria:

{
  "info_types": ["*"]
}

Para recuperar uma variedade de dados de mensagens de uma fonte de backup ou Reincubate Relay do iCloud, mas apenas a partir de uma certa data:

{
  "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"],
  "filters": {
    "since": "2019-09-15T22:04:12Z"
  }
}

Para recuperar dados de arquivo para imagens referenciadas em um resultado da Biblioteca de Fotos do iCloud:

{
  "files": ["icpl://xyz123", "icpl://abc321"]
}

Os diferentes atributos também podem ser usados simultaneamente:

{
  "info_types": ["*"],
  "data_types": ["ios_phone.calls"]
}

Criar POST /polls

Crie uma pesquisa de dados em uma sessão específica.

Como um recurso de sessão já está diretamente vinculado a uma fonte específica, você não precisa fornecer o parâmetro de source . No entanto, ele pode ser fornecido para especificar que a pesquisa vise uma fonte filho da origem primária à qual a sessão está vinculada. Por exemplo, no serviço iCloud, uma sessão só pode ser criada em relação às fontes da conta do iCloud (a principal fonte do serviço iCloud), mas você pode direcionar dados somente de um backup específico do iCloud (uma fonte filha da conta iCloud) IDENTIDADE.

nome tipo descrição
key ID de chave opcional Opcionalmente, substitua a chave usada para essa pesquisa. Isso é útil ao permitir que os usuários testem novas funcionalidades.
source ID de origem opcional Opcionalmente, segmente uma fonte filha da fonte vinculada à sessão.
session identificação de sessão A sessão a ser usada para autenticar a recuperação de dados.
payload carga útil da pesquisa aninhada A carga útil da pesquisa usada para especificar a pesquisa

Usando cURL

curl https://ricloud-api.reincubate.com/polls \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "payload": {
    "info_types": ["*"]
  }
}'

Usando ricloud-py

import ricloud

poll_payload = {
  'info_types': ['*'],
}

poll = ricloud.Poll.create(
  session='<session ID or ricloud.Session instance>',
  payload=poll_payload,
)

Recuperar GET /polls/{poll ID}

Usando cURL

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

Usando ricloud-py

import ricloud

poll = ricloud.Poll.retrieve(<poll ID>)

Listar GET /polls

nome tipo descrição
key ID da chave Filtrar por chave associada. Essa é a chave usada pelo usuário no momento.
user ID do usuário Filtrar por usuário associado.
source ID da fonte Filtrar pela fonte de destino.
session identificação de sessão Filtrar pela sessão de destino.
subscription ID de Inscrição Filtrar pela assinatura associada.
state corda Filtrar por estado de sessão.
date_created filtro de data e hora Filtrar por quando o recurso foi criado.
date_started filtro de data e hora Filtre por quando a pesquisa começou.
date_completed filtro de data e hora Filtrar por quando a pesquisa foi concluída.

Usando cURL

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

Usando ricloud-py

import ricloud

polls = ricloud.Poll.list()

Como podemos ajudar?

Nossa equipe de suporte está aqui para ajudar!

Nosso horário de atendimento é de segunda a sexta, das 9h às 17h GMT. A hora é atualmente 5:30 PM GMT.

Nosso objetivo é responder a todas as mensagens dentro de um dia útil.

Vá para a seção de apoio › Entre em contato com a equipe da empresa ›
Nossa equipe de suporte incrível

© 2008 - 2019 Reincubate Ltd. Todos os direitos reservados. Registrado na Inglaterra e no País de Gales #5189175, VAT GB151788978. Reincubate® é uma marca registrada. Privacidade e Termos. Recomendamos 2FA. Construído com em Londres.