api_get_entitymap_json – Proxima Research Ukraine

Отримує інформацію про відповідність назв полів, які бачить користувач у картках “Домовленість” і “Контроль”, системним колонкам у розрізі ролей користувачів.

Запит

Endpoint

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

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

Bearer Token (обов'язково)

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

Заголовки

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

Тіло запиту

{
    "function": "api_get_entitymap_json",
    "format": "json",
    "arguments": {
        "ids": "1,2,3,4"
    }
}

Поле	Тип	Обов'язкове	Опис
function	string	Так	Назва методу API: для цього запиту використовуйте "api_get_entitymap_json"
format	string	Так	Формат відповіді - json
arguments	object	Так	Блок параметрів.
ids	string	Ні	Приймає ідентифікатори записів із БД Proxima CRM, розділені комами

Успішна відповідь

200 OK

Формат

JSON

Приклад відповіді

[
    {
        "role": "ROLE_ADMIN",
        "entitytype": "arrangement",
        "enititymap_id": 82,
        "ui_field_name": "Потенціал",
        "system_field_name": "fact_potential"
    }
]

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

Помилкова відповідь

40x/50x

{
  "message": "string"
}

Код	Значення
400	Невірний запит (наприклад, відсутні обов’язкові параметри)
401	Неавторизований доступ (недійсний або відсутній токен)
500	Внутрішня помилка сервера

Пошук