api_get_entitymap – Proxima Research International

Retrieves information about the mapping between the field names visible to the user in the “Arrangement” and “Control” cards and the system columns, segmented by user roles.

Request

Endpoint

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

Authentication

Bearer Token (required)

Request Structure

Headers

Key	Value
Authorization	Bearer `<token>`
Content-Type	application/json

Request Body

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

Field	Type	Required	Description
function	string	Yes	API method name. For this request use `"api_get_entitymap"`.
format	string	Yes	Response format - csv
arguments	object	Yes	Parameters block
ids	string	No	Accepts record IDs from the Proxima CRM database, separated by commas

Successful Response

200 OK

Format

CSV text

Example Response

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

Field	Description
enititymap_id	Task name
entitytype	Entity identifier in the system: `pdk` – “Control” card `arrangement` – “Arrangement” card
role	User role in the system
system_field_name	System field name
action_tasktype	Task type (e.g., Meeting, Training, Administrative work)
ui_field_name	Name visible to the user in the interface

Error Response

Format

{
  "message": "string"
}

Code	Meaning
400	Bad request (e.g., missing required parameters)
401	Unauthorized access (invalid or missing token)
500	Internal server error

Search