Archivos fuente

El servicio de retransmisión incluye la funcionalidad para publicar archivos de origen utilizados durante la parte de extracción de datos de una encuesta. Por ejemplo, una encuesta para ios_messages.messages examinará el archivo sms.db de una copia de seguridad de iOS para recuperar los datos del mensaje; al usar el archivo de origen, el archivo sms.db se devolverá junto con los datos extraídos y cualquier archivo adjunto relevante.

Habilitación de la publicación de archivos de origen

La publicación de archivos de origen se puede habilitar por suscripción, a través de su atributo poll_payload , o mediante una configuración a nivel de clave o de toda la organización. Todos usan la misma clave de configuración: publish_source_files

Creación de una suscripción con la publicación de archivos de origen habilitada

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
  }
}'

Configuración de la publicación de archivos de origen a nivel de organización

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
  }
}'

Lo anterior requiere una clave de administrador de la organización.

Configuración de la publicación de archivos de origen a nivel de clave

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
  }
}'

Las configuraciones de toda la organización pueden anularse con configuraciones de nivel de clave, lo que puede ser útil cuando los archivos de origen solo son de interés para el uso de producción. Del mismo modo, ambos pueden ser anulados por el parámetro de carga útil de la encuesta, lo que le permite especificar si los archivos de origen deben publicarse caso por caso.

Tenga en cuenta que habilitar las funciones a través de la organización o la configuración clave aplicará retroactivamente el comportamiento modificado a las suscripciones existentes.

Trabajar con resultados de archivos de origen

Cuando la publicación de archivos de origen está habilitada, la API rastreará cualquier archivo tocado como parte del proceso de extracción, los publicará en su depósito de almacenamiento y creará un objeto de resultado asociado con la encuesta actual.

Se incluye una referencia a los archivos de origen relacionados con un conjunto particular de datos en el atributo de metadata del propio resultado de los datos. Por ejemplo:

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

Al igual que con los resultados del archivo adjunto, el file_id de una entrada del archivo de origen corresponde al atributo de identifier del resultado con el que está relacionado. Por lo tanto, este también es el nombre del archivo escrito en su depósito de almacenamiento.