api_get_entitymap – Proxima Research

Получает информацию по соотношению названий полей которые видит пользователь ,в карточках “Договоренность” и “Контроль”, и системными колонками в разрезе ролей пользователей.

Запрос

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Аутентификация

Bearer Token (обязателен)

Структура запиту

Заголовки

Ключ	Значение
Authorization	Bearer `<token>`
Content-Type	application/json

Тело запроса

{"function": "api_get_entitymap", 
 "format": "csv", 
 "arguments": {"ids": "1,2,3,4"}}

Поле	Тип	Обязательный	Описание
function	string	Да	Название метода API. Для этого запроса используйте "api_get_entitymap".
format	string	Да	Формат ответа - csv
arguments	object	Да	Блок параметров.
ids	string	Нет	Принимает идентификаторы записей из БД Proxima CRM, разделённых запятыми

Успешный ответ

200 OK

Формат "csv": ответ в виде текста CSV.

Content-Type

text/plain

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

enititymap_id,entitytype,role,system_field_name,ui_field_name
82,arrangement,ROLE_ADMIN,fact_potential,Потенціал
87,pdk,ROLE_ADMIN,int2,Замовлення

Поле	Описание
enititymap_id	Название задачи
entitytype	Идентификатор сущности в системе pdk - карточка “контроль” arrangement - карточка “договоренности”
role	Роль пользователя в системе
system_field_name	Системное название поле
action_tasktype	Тип задачи (например, Встреча, Обучение, Административная работа)
ui_field_name	Название, которое видит пользователь в интерфейсе

Ошибочный ответ

40x/50x

{
  "message": "string"
}

Код	Описание
400	Неверный запрос (например, отсутствуют обязательные параметры)
401	Неавторизовано (недействительный или отсутствующий токен)
500	Внутренняя ошибка сервера

Поиск