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

Метод Create note используется для добавления комментария к указанной сущности в платформе.

Метод недоступен для менеджеров с ролью Продукт-менеджер (см. Получение информации о менеджере).

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/notes

Аргументы

Название		Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token		header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type		header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept		header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url		path	string	Обязательный	URL ActivePlatform
reseller_id		path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
id		form	integer	Обязательный	ID сущности в платформе, к которой добавляется комментарий и которая принадлежит указанному реселлеру
type		form	string	Обязательный	Тип сущности в платформе, к которой добавляется комментарий. Поддерживаются следующие значения: account — Клиент. subscription — Подписка. order — Заказ.
content		form	string	Обязательный	Текст комментария до 5000 символов
attachment		form	object	Опциональный	Информация о файле, прикрепленном к комментарию
	name	form	string	Опциональный	Обязательный при наличии `attachment`. Имя файла и его расширение
	data	form	string	Опциональный	Обязательный при наличии `attachment`. Файл в кодировке base64 с указанием MIME-типа данных (см. Список MIME-типов) размером до 2 МБ. Формат данных: `data:<MIME-тип данных>;base64,'содержимое в кодировке base64'`

Модель ответа

В случае отсутствия ошибок метод возвращает информацию о созданном комментарии аналогично методу Получение информации о комментарии. Код ответа: 201 Created.

Пример запроса

POST /api/v3/resellers/1/notes
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
  "data": {
    "attributes": {
      "id": 3056,
      "type": "subscription",
      "content": "Migrated 01.03.2022",
            "attachment":
            {
                "name": "ai_pine.pdf",
                "data": "data:application/pdf;base64,'SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdpbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBpbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29ycmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJlbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUuZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikgVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFydCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9jZXNzLg=='"
            }
        }
    }
}

Пример ответа

{
    "data": {
        "id": "15",
        "type": "notes",
        "attributes": {
            "created_at": "2023-03-27T11:35:12.509+03:00",
            "updated_at": "2023-03-27T11:35:12.509+03:00",
            "content": "Migrated 01.03.2022",
            "creator": "Bill Smith",
            "original_link": "/admin/subscription/3056/notes/15",
            "original_id": 3056,
            "original_type": "Subscription",
            "attachment": {
                "name": "ai_pine.pdf",
                "url": "https://storage.test.activeplatform.com/private/uploads/note/attachment/15/ai_pine.pdf?expires=1680009898&hash=DStusb6w",
                "size": 3439
            }
        }
    }
}