Polls

Een peilingsbron bevat informatie over een specifiek verzoek om gegevens. Nadat een peiling is gemaakt, worden er één of meer taken gestart om het verzoek te voltooien.

attributen

Taken

De belangrijkste rol van de peilingsbron is om de voortgang van de bijbehorende taken weer te geven en de eindgebruiker in staat te stellen hieruit resultaten op te halen zodra deze beschikbaar komen. Daarom onthult de peilingbron taakgerelateerde attributen waarin bijbehorende taken worden gecategoriseerd op basis van hun status.

Resultaten

Any results published by tasks running within the poll are surfaced in the poll's results attribute. This allows for consumption of results before the poll has completed.

fouten

Any errors raised by tasks running within the poll will appear in the poll's errors attribute.

Staten

De status van een peiling geeft alleen aan of de peiling wacht op initialisatie (in pending ), aan de gang is ( processing ) of dat alle taken zijn voltooid ( completed ).

Een peiling geeft geen enkele foutstatus weer, behalve via de bijbehorende taken.

Laadvermogen

De payload van de enquête geeft aan welke soorten informatie, gegevenstypen en bestanden moeten werken om op te halen. Het schema met de kenmerken van de poll-payload wordt hieronder beschreven.

De poll-payload om alle soorten informatie over een iCloud-accountbron op te halen zou bijvoorbeeld zijn:

{
  "info_types": ["*"]
}

Een verscheidenheid aan berichtgegevens ophalen uit een iCloud-back-up of Reincubate Relay-bron, maar alleen vanaf een bepaalde datum:

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

Bestandsgegevens ophalen voor afbeeldingen waarnaar wordt verwezen in een iCloud-fotobibliotheekresultaat:

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

De verschillende attributen kunnen ook tegelijkertijd worden gebruikt:

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

Maak POST /polls

Maak een peiling voor gegevens tegen een specifieke sessie.

The source parameter should only be used when targeting a child source of the session's primary source. For example, if retrieving data from a rirelay.source the source parameter should be the ID of that source.

CURL gebruiken

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": ["*"]
  }
}'

Ricloud-py gebruiken

import ricloud

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

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

Voorbeeldantwoord

{
  "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
}

Ophalen GET /polls/{poll ID}

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Lijst GET /polls

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

polls = ricloud.Poll.list()

Changelog

2020-05-05

• The errors attribute was added to the poll object. This is a nested list object containing error objects associated with the poll.

2020-02-20

• Belangrijk : Het results van het poll-object is nu een genest lijstobject, in plaats van een eenvoudig lijstkenmerk. Dit maakt het mogelijk om resultaten te pagineren wanneer een poll een groot aantal resultaten publiceert.

16-10-2019

• Voegt het subscription toe aan het poll-object om aan te geven of de poll is geactiveerd door een abonnement.

01-06-2019

• Het kenmerk payload poll-object kan nu worden samengesteld uit meerdere bewerkingstypen. Dit betekent dat er een poll kan worden gemaakt met een of alle info-types , data-types en files in de payload.
• Major Het type attribuut op het poll-object is verouderd ten gunste van samen te stellen poll-payloads.