Центр поддержкиИнтеграции

Для: Администраторы

Добавляйте заметки к делам с помощью ключа-хаба.

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

В этой статье7 разделов

Прежде чем начать

На этой странице рассказывается о добавлении и чтении записейЗаметки Внутренние заметки по делу доступны только тем, чья должность это позволяет; клиенты не могут их увидеть, если фирма не изменит это. появления случаев с использованием ключа “hub”. Пути для доступа к этим записям указаны в разделе https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Звонки

ВызовЧто это делает
GET /notes/templatesСписок шаблонов ваших заметок
POST /notesСоздается записка.
GET /notesВ списке указаны все записи по делу; самые последние записи расположены в начале списка.
GET /notes/<note_id>Читает одно сообщение.
PUT /notes/<note_id>Изменяет название заметки или того, кто может её просмотреть.
DELETE /notes/<note_id>Удаляется запись вместе с соответствующими файлами.

Записка представляет собой документ, хранящийся в отдельном разделе для вашей команды. В нее включаются все файлы, связанные с этим документом. Содержимое записки может быть создано на основе шаблона или же можно загрузить PDF- или Word-файл после того, как записка уже будет создана. В записке нет полей для ввода текста. Никто не уведомляется о времени добавления или изменения записи. Кроме того, записки не содержат каких-либо оповещений через вебхокны.

Создание заметки

ПолеЧто это делаетНеобходимыйПо умолчанию
nameНазвание записки: буквы, цифры, пробелы и символ & ' - _ ( ) . /. Нет каваджей, точек, вопросительных знаков или скобок.Да.—
permissionsЭто… РолиРоль Набор разрешений, определяющий, что может видеть и делать тот или иной пользователь в рамках дела, например, сотрудники или клиенты. Те, кто может это увидеть… ["role::staff"]. Только те роли, которые могут читать ноты.Нет.Роли шаблона, или все роли, которые могут читать записи.
templateОт {"owner": "host", "template_id": "<asset_id>"} до GET /notes/templates – для привода документа и файлов шаблона. Или от {"owner": "case", "template_id": "<note_id>"} – для копирования информации по данному случаю.Нет.Ничего.
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'

Это соответствие между 201 и note_id.

  • Из шаблона нота получает документ, файлы и полномочия, предусмотренные этим шаблоном. Коды, такие как имя клиента, заполняются при создании ноты. Коды, указывающие на лицо человека, который создал ноту, берутся из данных виртуального помощника; эти данные содержат название вашей компании. Название ноты не копируется: необходимо отправить name.
  • Копия записки по этому делу сохраняет все написанное или нарисованное на ней. Если вы отправите schema вместо этого, то коды снова будут заполнены в соответствии с данными, имеющимися на момент создания копии.
  • Без шаблона необходимо загрузить соответствующий документ: указать адрес с помощью media_group=schemas, загрузить PDF- или Word-файл, а затем прикрепить его с помощью PUT /notes/<note_id>/schema/media. Word-файл преобразуется в PDF-формат. Один документ может содержать несколько записей. См. раздел Загрузка и прикрепление файлов с использованием ключа хаба.
  • Другие файлы, такие как фотографии или записи, следует прикреплять с помощью символа PUT /notes/<note_id>/media.

Кто это увидит?

Люди, которые выполняют определенные роли в системе, могут открывать эти записи. Сотрудники, которые по умолчанию имеют право модерировать записи, могут видеть все записи, независимо от их ролей. Клиенты не могут видеть записи, если администратор не предоставил им права на доступ к ним. Подробнее о правилах использования различных ролей смотрите в разделе Что может делать каждая роль.

Примечания к чтению

GET /notes принимает значения limit (по умолчанию – 20; до 1000). Также необходимо указать значение start_key. Страницы располагаются, как и в любом списке. Ключ считает все элементы списка. Каждый элемент списка содержит…

ПолеЧто в нём содержится
note_id, case_idЕго идентификационные номера
nameЕго название
user_idКто это сделал? Это был идентификатор виртуального помощника. Возможно, это было сделано для удобства или автоматически.
permissionsРоли, которые могут видеть это. Оставлены в стороне те роли, которые могут читать ноты.
schema_mediamedia_id его документа
media, media_ctЕго документы и файлы можно скачать по указанной ссылке: Загрузите и приложите файлы, используя ключ для загрузки файлов.
schemaТо, что люди вводят или рисуют на документе, в формате Instant JSON.
template_idЭтот шаблон был создан из каких-то материалов/элементов.
created_on, updated_onКогда это произошло, а также когда производилась последняя модификация – в UTC.

GET /notes/templates Перечисление ваших опубликованных заметок. ШаблоныШаблон Многоразовая запись в ленте новостей, форма, электронная подпись, заметка или задание, хранящиеся в библиотеке и копируемые на витрины., Старшие по возрасту первыми, каждый из них… asset_id, title, description и permissions.

Изменение и удаление

PUT /notes/<note_id> принимает значения name и permissions, и изменяет только те значения, которые вы передаете. Ключ может изменять любую ноту в случае необходимости. Пустой список permissions отклоняется: необходимо указать роли, которым этот элемент должен быть доступен. Если в теле не указаны какие-либо значения, это также отклоняется.

DELETE /notes/<note_id> удаляет все записи, а также соответствующие документы и файлы. Об этом никому не сообщается.

Если звонок отклонен

СтатусmessageПочему
400SchemaFieldsExceptionПроблема заключается в том, что поле не предоставлено или имеет некорректный формат. Например, может быть неправильное расположение запятых в строке name, пустой список в строке permissions, или роль, которую у вашего хаба нет. В таких случаях значения в строке errors не имеют смысла.
400SchemaFieldsException, при условии, что ItemCopyNotAllowedException находится в пределах templateШаблон еще не опубликован, он не доступен для использования роботами, или его файлы все еще обрабатываются.
400SchemaFieldsException, при условии, что NoteRoleCannotReadNotesException находится в пределах permissions.<n>Роль в permissions не может быть прочитана.
403HostModuleDisabledExceptionЗаметки отключены для вашего хаба, или скрыты в этом чехле.
403CaseClosedExceptionДело закрыто.
404ItemNotFoundExceptionЭта записка не существует.

Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.

Статьи по теме

Разберитесь, что может делать API.Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.ИнтеграцииЗагружайте и прикрепляйте файлы с помощью ключа хаба.Получите адрес для загрузки, загрузите файл, прикрепите его к сообщению, заметке, заданию, форме или электронной подписи, а также скачайте файлы дела.ИнтеграцииДобавить внутреннюю заметку к обращениюВедите внутреннюю запись по делу в виде документа вместе с файлами и выберите, какие роли, помимо сотрудников, могут ее видеть.Случаи и прием · 3 minОбработка ошибок и кодов состояния API.Прочитайте текст ошибки, что означают коды 400, 401, 403, 404, 500 и 503, и почему элемент, который ваш ключ не видит, выдает ошибку 404.Интеграции