Получение файлов через API Sherlock Platform

Последние изменения: 28.02.2023

Для работы с файлами через API Sherlock Platform сначала надо авторизоваться.

Для получения файлов, полученными в Sherlock Platform от клиентов, необходимо использовать один из методов контролера Files. Получить файлы можно по идентификатору объекта, к которому привязаны файлы (например, id сообщения) или по id клиента.

Для получения файлов по объекту используется метод https://<sherlock_url>/API/V2/Files/{ObjectId}, где ObjectId - id объекта. Для получения файлов по клиенту используется метод https://<sherlock_url>/API/V2/Files/GetAllByClientId/{ClientId}, где clientId - id клиента.

Методы возвращают json с данными файлов, включая:

[
  {
    "id": "0568e3c4-ab76-4db6-a8c5-7ff2c8ff2ef9",
    "fileId": "ba675f68-f599-4201-8573-008a69afb92e",
    "objectId": "9c4b862a-d96c-4278-a2ab-16721d1651f3",
    "systemDictionaryId": "35df8dfe-d88a-4992-a4d4-54040166ca25",
    "fileName": "согласие пластические операции.docx",
    "physicalName": "6c1af3ee-cdaa-4ae8-aeb3-8d5f2f7a1a08.docx",
    "extension": ".docx",
    "url": "https://<sherlock_url>/API/v2/Files/0568e3c4-ab76-4db6-a8c5-7ff2c8ff2ef9/согласие пластические операции.docx/Attachment",
    "attachmentTypeId": 1
  }
]

Важно: обратите внимание, что метод получения файлов по id объекта не вернет каких-либо записей в случае передачи id клиента, так как требует id объекта непосредственно связанного с файлом.

Помогла ли вам статья?