sondaggi

aggiornato
Cover image for: sondaggi

Una risorsa sondaggio contiene informazioni su una richiesta specifica di dati. Una volta creato un sondaggio, verrà avviata la creazione di una o più attività per completare la richiesta.

attributi

nome genere descrizione
id sondaggio ID Identificatore di risorse
resource stringa, sempre poll Specificatore del tipo di risorsa.
organisation ID dell'organizzazione L'organizzazione associata a questa risorsa.
key ID chiave La chiave associata a questa risorsa.
user ID utente L'utente associato a questa risorsa.
source ID sorgente La fonte che il sondaggio sta prendendo di mira. Questa può essere una fonte secondaria dell'origine della sessione.
session ID della sessione La sessione che sta usando il sondaggio.
subscription ID abbonamento opzionale L'ID oggetto sottoscrizione associato, se applicabile.
tasks_pending elenco degli ID delle attività Le attività associate al sondaggio che sono in attesa di elaborazione.
tasks_processing elenco degli ID delle attività Le attività associate al sondaggio che si sta elaborando.
tasks_succeeded elenco di ID attività Attività associate al sondaggio riuscite.
tasks_failed elenco di ID attività Attività associate al sondaggio non riuscite.
tasks_suspended elenco di ID attività Le attività associate al sondaggio sono sospese.
results lista oggetto contenente oggetti risultato Elenco di oggetti risultato generati dalle attività del sondaggio.
errors oggetto elenco contenente oggetti errore Elenco di oggetti di errore generati dalle attività del sondaggio.
state stringa Uno dei seguenti: in pending , in processing , completed .
date_created appuntamento Quando la risorsa è stata creata.
date_started datetime opzionale Quando è iniziata l'elaborazione del sondaggio.
date_completed datetime opzionale Al termine dell'elaborazione del sondaggio.

Compiti

Il ruolo più importante della risorsa sondaggio è quello di riflettere l'avanzamento delle attività associate e consentire all'utente finale di iniziare a recuperare i risultati da questi non appena diventano disponibili. Pertanto, la risorsa di polling espone gli attributi relativi alle attività in cui le attività associate sono classificate in base al loro stato.

risultati

Tutti i risultati pubblicati dalle attività in esecuzione nel sondaggio vengono visualizzati nell'attributo dei results del sondaggio. Ciò consente il consumo dei risultati prima del completamento del sondaggio.

Errori

Tutti gli errori generati dalle attività in esecuzione nel sondaggio verranno visualizzati nell'attributo errors del sondaggio.

stati

Lo stato di un sondaggio riflette solo se il sondaggio è in attesa di inizializzazione (in pending ), è in corso ( processing ), o tutte le attività hanno terminato l'esecuzione ( completed ).

Un sondaggio non riflette nessuno stato di errore se non attraverso i suoi compiti associati.

Carico utile

Il payload del sondaggio indica quali tipi di informazioni, tipi di dati e file devono funzionare per il recupero. Lo schema dell'attributo del payload del poll è descritto di seguito.

nome genere descrizione
info_types elenco di oggetti info_type Specifica quali tipi di informazioni devono essere recuperati. Supporta caratteri jolly * .
data_types elenco di oggetti data_type Specifica quali tipi di dati devono essere recuperati.
files elenco di ID file . Specifica quali file recuperare.
filters oggetto filters nidificati Specifica quali filtri applicare ai dati recuperati.

Ad esempio, il payload del sondaggio per recuperare tutti i tipi di informazioni su un'origine dell'account iCloud sarebbe:

{
  "info_types": ["*"]
}

Per recuperare una varietà di dati di messaggistica da una copia di backup iCloud o Reincubate Relay, ma solo da una determinata data:

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

Per recuperare i dati dei file per le immagini a cui fa riferimento un risultato della Libreria foto iCloud:

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

I diversi attributi possono anche essere usati contemporaneamente:

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

Crea POST /polls

Crea un sondaggio per i dati rispetto a una sessione specifica.

Il parametro source deve essere utilizzato solo quando si sceglie come target un'origine figlio dell'origine principale della sessione. Ad esempio, se si recuperano dati da una source rirelay.source il parametro source dovrebbe essere l'ID di quella sorgente.

nome genere descrizione
key opzionale, ID chiave Opzionalmente sovrascrivere la chiave utilizzata per questo sondaggio. Questo è utile quando gli utenti provano nuove funzionalità.
source opzionale, ID sorgente Facoltativamente, scegliere come destinazione un'origine figlio dell'origine collegata alla sessione.
session ID della sessione La sessione da utilizzare per autenticare il recupero dei dati.
subscription ID abbonamento L'abbonamento da utilizzare per eseguire il sondaggio. Se fornito, l' source e la session possono essere omesse.
payload payload del sondaggio nidificato Il payload del sondaggio utilizzato per specificare il sondaggio

Utilizzando 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,
)

Risposta del campione

{
  "id": "54554389-5f1a-4ccf-9bb8-024a031cf948",
  "resource": "poll",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "f5a7a7ef-ff21-47fe-9aa6-7ebd08123623",
  "subscription": null,
  "tasks_pending": [],
  "tasks_processing": [],
  "tasks_succeeded": [],
  "tasks_failed": [],
  "tasks_suspended": [],
  "results": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/results"
  },
  "errors": {
    "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/errors"
  },
  "state": "pending",
  "date_created": "2020-02-20T11:59:14.694337Z",
  "date_started": null,
  "date_completed": null
}

Recupera GET /polls/{poll ID}

Utilizzando 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>)

Elenca GET /polls

nome genere descrizione
key ID chiave Filtra per chiave associata. Questa è la chiave utilizzata dall'utente al momento.
user ID utente Filtra per utente associato.
source ID sorgente Filtra per la fonte di destinazione.
session ID della sessione Filtra per la sessione di destinazione.
subscription ID abbonamento Filtra per abbonamento associato.
state stringa Filtra per stato di sessione.
date_created filtro datetime Filtra per quando la risorsa è stata creata.
date_started filtro datetime Filtra per quando è iniziato il sondaggio.
date_completed filtro datetime Filtra per quando il sondaggio è stato completato.

Utilizzando cURL

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

Usando ricloud-py

import ricloud

polls = ricloud.Poll.list()

changelog

2020/05/05

  • L'attributo errors stato aggiunto all'oggetto poll. Questo è un oggetto elenco nidificato contenente oggetti di errore associati al sondaggio.

2020/02/20

  • Maggiore : l'attributo dei results dell'oggetto sondaggio è ora un oggetto elenco nidificato, anziché un semplice attributo elenco. Ciò consente di impaginare i risultati quando un sondaggio pubblica un numero elevato di risultati.

2019/10/16

  • Aggiunge l'attributo di subscription all'oggetto sondaggio per indicare se il sondaggio è stato attivato da una sottoscrizione.

2019/06/01

  • L'attributo payload dell'oggetto poll può ora essere composto da più tipi di operazioni. Ciò significa che è possibile creare un sondaggio con uno o tutti info-types di info-types data-types e files nel payload.
  • Maggiore L'attributo type sull'oggetto poll è deprecato a favore dei payload di poll componibili.

Come possiamo aiutare?

Il nostro team di supporto è qui per aiutarti!

I nostri orari di ufficio sono dal lunedì al venerdì, dalle 9:00 alle 17:00 GMT. L'ora è attualmente 9:46 AM GMT.

Miriamo a rispondere a tutti i messaggi entro un giorno lavorativo.

Vai alla sezione di supporto › Contatta il team aziendale ›
Il nostro fantastico team di supporto

© 2008 - 2020 Reincubate Ltd. Tutti i diritti riservati. Registrato in Inghilterra e Galles #5189175, VAT GB151788978. Reincubate® è un marchio registrato. Politica sulla riservatezza & condizioni. Raccomandiamo 2FA. Costruito con a Londra.