Umfragen

Eine Umfrageressource enthält Informationen zu einer bestimmten Datenanforderung. Sobald eine Umfrage erstellt wurde, werden eine oder mehrere Aufgaben erstellt, um die Anforderung abzuschließen.
Attribute
Name | Art | Beschreibung |
---|---|---|
id | Umfrage-ID | Ressourcenkennung. |
resource | string, immer poll | Ressourcentypbezeichner. |
organisation | Organisations-ID | Die Organisation, die dieser Ressource zugeordnet ist. |
key | Schlüssel-ID | Der dieser Ressource zugeordnete Schlüssel. |
user | Benutzeridentifikation | Der Benutzer, der dieser Ressource zugeordnet ist. |
source | Quell-ID | Die Quelle, auf die die Umfrage abzielt. Dies kann eine untergeordnete Quelle der Sitzungsquelle sein. |
session | Session-ID | Die Sitzung, die die Umfrage verwendet. |
subscription | optionale Abo-ID | Die zugehörige Abonnementobjekt-ID, falls zutreffend. |
tasks_pending | Liste der Aufgaben-IDs | Die mit der Umfrage verbundenen Aufgaben, die auf die Verarbeitung warten. |
tasks_processing | Liste der Aufgaben-IDs | Die mit der Umfrage verbundenen Aufgaben, die verarbeitet werden. |
tasks_succeeded | Liste der Aufgaben-IDs | Die mit der Umfrage verbundenen Aufgaben, die erfolgreich waren. |
tasks_failed | Liste der Aufgaben-IDs | Die mit der Umfrage verbundenen Aufgaben, die fehlgeschlagen sind. |
tasks_suspended | Liste der Aufgaben-IDs | Die mit der Umfrage verbundenen Aufgaben, die angehalten werden. |
results | Listenobjekt mit Ergebnisobjekten | Liste der Ergebnisobjekte, die von den Aufgaben der Umfrage generiert wurden. |
errors | Listenobjekt mit Fehlerobjekten | Liste der Fehlerobjekte, die von den Aufgaben der Umfrage generiert wurden. |
state | Zeichenfolge | Eines von: pending , processing , completed . |
date_created | Terminzeit | Wann wurde die Ressource erstellt. |
date_started | optional datetime | Mit der Bearbeitung der Umfrage wurde begonnen. |
date_completed | optional datetime | Wenn die Bearbeitung der Umfrage beendet ist. |
Aufgaben
Die wichtigste Aufgabe der Abfrageressource besteht darin, den Fortschritt der zugeordneten Aufgaben wiederzugeben und es dem Endbenutzer zu ermöglichen, Ergebnisse von diesen abzurufen, sobald sie verfügbar sind. Daher macht die Abfrageressource aufgabenbezogene Attribute verfügbar, bei denen zugeordnete Aufgaben nach ihrem Status kategorisiert werden.
Ergebnisse
Alle Ergebnisse, die von Aufgaben veröffentlicht wurden, die in der Umfrage ausgeführt werden, werden im results
der Umfrage angezeigt. Dies ermöglicht den Verbrauch von Ergebnissen, bevor die Umfrage abgeschlossen ist.
Fehler
Alle Fehler, die durch Aufgaben ausgelöst werden, die in der Umfrage ausgeführt werden, werden im Fehlerattribut der Umfrage errors
.
Zustände
Der Status einer Umfrage gibt nur an, ob die Umfrage auf die Initialisierung wartet ( pending
), in Bearbeitung ist ( processing
) oder alle Aufgaben die Ausführung beendet haben ( completed
).
Eine Umfrage spiegelt keine anderen Fehlerzustände als die zugehörigen Aufgaben wider.
Nutzlast
Die Poll-Payload gibt an, welche Arten von Informationen, Datentypen und Dateien abgerufen werden sollen. Das Poll-Payload-Attributschema wird unten beschrieben.
Name | Art | Beschreibung |
---|---|---|
info_types | Liste von info_type Objekten | Gibt an, welche Infotypen abgerufen werden sollen. Unterstützt Platzhalter * . |
data_types | Liste der data_type Objekte | Gibt an, welche Datentypen abgerufen werden sollen. |
files | Liste der file IDs. | Gibt an, welche Dateien abgerufen werden sollen. |
filters | Objekt für verschachtelte filters | Gibt an, welche Filter auf abgerufene Daten angewendet werden sollen. |
Die Poll-Payload zum Abrufen aller Arten von Informationen in einer iCloud-Kontoquelle lautet beispielsweise:
{ "info_types": ["*"] }
So rufen Sie eine Vielzahl von Messaging-Daten von einer iCloud-Sicherung oder einer Reincubate-Relay-Quelle ab, jedoch nur von einem bestimmten Datum:
{ "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"], "filters": { "since": "2019-09-15T22:04:12Z" } }
So rufen Sie Dateidaten für Bilder ab, auf die in einem iCloud Photo Library-Ergebnis verwiesen wird:
{ "files": ["icpl://xyz123", "icpl://abc321"] }
Die verschiedenen Attribute können auch gleichzeitig verwendet werden:
{ "info_types": ["*"], "data_types": ["ios_phone.calls"] }
Erstellen Sie POST /polls
Erstellen Sie eine Datenabfrage für eine bestimmte Sitzung.
Die source
- Parameter sollten nur verwendet werden , wenn ein Kind Quelle der Sitzung des Hauptquelle Targeting. Wenn beispielsweise das Abrufen von Daten aus einer rirelay.source
die source
sollte die ID dieser Quelle sein.
Name | Art | Beschreibung |
---|---|---|
key | Optional, Schlüssel-ID | Überschreiben Sie optional den für diese Umfrage verwendeten Schlüssel. Dies ist nützlich, wenn Benutzer neue Funktionen testen können. |
source | Optional, Quell-ID | Greifen Sie optional auf eine untergeordnete Quelle der sitzungsgebundenen Quelle zu. |
session | Session-ID | Die Sitzung, die zum Authentifizieren des Datenabrufs verwendet werden soll. |
subscription | Abonnement-ID | Das Abonnement, das zur Durchführung der Umfrage verwendet werden soll. Wenn dies angegeben ist, können source und session weggelassen werden. |
payload | geschachtelte Poll-Payload | Die Poll-Payload, die zum Angeben von Polls verwendet wird |
CURL verwenden
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": ["*"] } }'
Mit Ricloud-Py
import ricloud poll_payload = { 'info_types': ['*'], } poll = ricloud.Poll.create( session='<session ID or ricloud.Session instance>', payload=poll_payload, )
Beispielantwort
{ "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 }
GET /polls/{poll ID}
CURL verwenden
curl https://ricloud-api.reincubate.com/polls/<poll ID> \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud poll = ricloud.Poll.retrieve(<poll ID>)
Liste GET /polls
Name | Art | Beschreibung |
---|---|---|
key | Schlüssel-ID | Filtern nach zugeordnetem Schlüssel. Dies ist der Schlüssel, den der Benutzer zu diesem Zeitpunkt verwendet. |
user | Benutzeridentifikation | Filtern nach zugeordnetem Benutzer. |
source | Quell-ID | Filtern Sie nach der Zielquelle. |
session | Session-ID | Filtern Sie nach der Zielsitzung. |
subscription | Abo-ID | Filtern Sie nach dem zugehörigen Abonnement. |
state | Zeichenfolge | Filtern nach Sitzungsstatus. |
date_created | Datum / Uhrzeit-Filter | Filtern nach dem Zeitpunkt, zu dem die Ressource erstellt wurde. |
date_started | Datum / Uhrzeit-Filter | Filtern nach, wann die Umfrage gestartet wurde. |
date_completed | Datum / Uhrzeit-Filter | Filtern nach, wann die Umfrage beendet wurde. |
CURL verwenden
curl https://ricloud-api.reincubate.com/polls \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud polls = ricloud.Poll.list()
Änderungsprotokoll
2020-05-05
- Das Attribut
errors
wurde dem Umfrageobjekt hinzugefügt. Dies ist ein verschachteltes Listenobjekt, das Fehlerobjekte enthält, die der Abfrage zugeordnet sind.
2020-02-20
- Major : Das
results
des Abfrageobjekts ist jetzt ein verschachteltes Listenobjekt und kein einfaches Listenattribut mehr. Dies ermöglicht es, Ergebnisse zu paginieren, wenn eine Umfrage eine große Anzahl von Ergebnissen veröffentlicht.
2019-10-16
- Fügt dem Umfrageobjekt das
subscription
, um anzugeben, ob die Umfrage durch ein Abonnement ausgelöst wurde.
2019-06-01
- Das
payload
Abfrageobjekts kann jetzt aus mehreren Operationstypen bestehen. Dies bedeutet, dass eine Umfrage mit einem oder alleninfo-types
,data-types
undfiles
in der Nutzlast erstellt werden kann. - Major Das
type
Attribut für das Poll-Objekt ist zugunsten komponierbarer Poll-Nutzdaten veraltet.