Bronbestanden

De Relay-service bevat functionaliteit voor het publiceren van bronbestanden die worden gebruikt tijdens het gegevensextractiegedeelte van een peiling. Een peiling voor ios_messages.messages kijkt bijvoorbeeld naar het sms.db bestand van een iOS-back-up om berichtgegevens op te halen - met behulp van bronbestandpublicatie wordt het sms.db -bestand zelf geretourneerd samen met de geëxtraheerde gegevens en eventuele relevante bijlagebestanden.

Publicatie van bronbestanden inschakelen

Het publiceren van bronbestanden kan per abonnement worden ingeschakeld, via het poll_payload attribuut, of via een configuratie voor de hele organisatie of op sleutelniveau. Ze gebruiken allemaal dezelfde configuratiesleutel: publish_source_files

Een abonnement maken met publiceren van bronbestanden ingeschakeld

curl https://ricloud-api.reincubate.com/subscriptions \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "source": "<child source ID>",
  "poll_payload": {
    "data_types": ["ios_messages.messages"],
    "publish_source_files": true
  }
}'

Het publiceren van bronbestanden configureren op organisatieniveau

curl https://ricloud-api.reincubate.com/organisation \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Voor het bovenstaande is een beheerderssleutel van de organisatie vereist.

Het publiceren van bronbestanden configureren op sleutelniveau

curl https://ricloud-api.reincubate.com/key \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "publish_source_files": true
  }
}'

Configuraties voor de hele organisatie kunnen worden overschreven door configuraties op sleutelniveau, wat handig kan zijn wanneer bronbestanden alleen van belang zijn voor productiegebruik. Op dezelfde manier kunnen beide worden overschreven door de payloadparameter poll, zodat u per geval kunt specificeren of bronbestanden moeten worden gepubliceerd.

Houd er rekening mee dat het inschakelen van functies via organisatie- of sleutelconfiguratie het gewijzigde gedrag met terugwerkende kracht toepast op bestaande abonnementen.

Werken met bronbestandsresultaten

Wanneer het publiceren van bronbestanden is ingeschakeld, volgt de API alle bestanden die zijn aangeraakt als onderdeel van het extractieproces, publiceert ze naar uw opslagbucket en maakt een resultaatobject dat is gekoppeld aan de huidige peiling.

Een verwijzing naar de bronbestanden met betrekking tot een bepaalde set gegevens is opgenomen in het metadata -attribuut van het gegevensresultaat zelf. Bijvoorbeeld:

{
  "data": [{
    "id": "a1b2c3d4",
    "data_type": "message",
    "conversation_id": "w6x7y8z9",
    "handle": "Pal",
    "type": "SMS",
    "text": "Hi, how’s it going?",
    "attachments": [{
          "type": "image",
          "file_id": "a492be9a8dadabdc774286116232420224f14976",
          "file_path": "Library/SMS/Attachments/de/14/33A09D66-287E-4B64-A874-1A1234BD7E61/IMG_0006.PNG",
          "filename": "IMG_0006.PNG"
    }],
    "group_handles": [
      "Pal",
      "renate@reincubate.com"
    ],
    "from_me": false,
    "deleted": false,
    "date": "2020-01-01T00:00:00.000000Z"
  }],
  "metadata": {
    "count": 1,
    "filters": null,
    "source_files": [{
      "file_id": "3d0d7e5fb2ce288813306e4d4636395e047a3d28",
      "domain": "HomeDomain",
      "file_path": "Library/SMS/sms.db",
      "filename": "sms.db",
      "size": 123456,
      "date_last_modified": "2020-01-02T00:00:00.000000Z"
    }]
  }
}

Net als bij bijlagebestandsresultaten, komt de file_id van een bronbestandsitem overeen met het identifier van het resultaat waaraan het gerelateerd is. Daarom is dit ook de naam van het bestand dat naar uw opslagbucket is geschreven.