Исходные файлы

Служба ретрансляции включает в себя функцию публикации исходных файлов, используемых во время части извлечения данных опроса. Например, опрос для ios_messages.messages будет просматривать файл sms.db из резервной копии iOS для извлечения данных сообщения — при публикации исходного файла сам файл sms.db будет возвращен вместе с извлеченными данными и любыми соответствующими файлами вложений.

Включение публикации исходного файла

Публикация исходных файлов может быть включена для каждой подписки с помощью атрибута poll_payload или с помощью конфигурации на уровне всей организации или на уровне ключа. Все используют один и тот же ключ конфигурации: publish_source_files

Создание подписки с включенной публикацией исходного файла

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

Настройка публикации исходных файлов на уровне организации

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

Для вышеуказанного требуется ключ администратора организации.

Настройка публикации исходного файла на уровне ключа

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

Конфигурации для всей организации могут быть переопределены конфигурациями на уровне ключей, что может быть полезно, когда исходные файлы представляют интерес только для производственного использования. Точно так же оба могут быть переопределены параметром полезной нагрузки опроса, что позволяет указать, следует ли публиковать исходные файлы в каждом конкретном случае.

Обратите внимание, что включение функций с помощью организации или конфигурации ключа задним числом применит измененное поведение к существующим подпискам.

Работа с исходным файлом результатов

Когда публикация исходных файлов включена, API будет отслеживать любые файлы, затронутые в процессе извлечения, публиковать их в сегменте хранилища и создавать объект результата, связанный с текущим опросом.

Ссылка на исходные файлы, относящиеся к конкретному набору данных, включается в атрибут metadata самого результата данных. Например:

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

Как и в случае с результатами файлов вложений, file_id записи исходного файла соответствует атрибуту identifier результата, с которым он связан. Следовательно, это также имя файла, записываемого в корзину хранилища.