api_get_entitymap – Proxima Research Brazil

Obtém informações sobre a correspondência entre os nomes dos campos vistos pelo usuário nas tarjetas “Acordo” e “Controle” e as colunas sistêmicas correspondentes, de acordo com os papéis dos usuários.

Solicitação

Endpoint

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

Autenticação

Bearer Token (obrigatório)

Estrutura da solicitação

Cabeçalhos

Chave	Valor
Authorization	Bearer `<token>`
Content-Type	application/json

Corpo da solicitação

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

Campo	Tipo	Obrigatório	Descrição
function	string	Sim	Nome do método API — "api_get_entitymap"
format	string	Sim	Formato da resposta — csv
arguments	object	Sim	Bloco de parâmetros
ids	string	Não	Identificadores de registros do Proxima CRM, separados por vírgulas

Resposta bem-sucedida

200 OK

Formato csv — retorno em texto CSV.

Content-Type

text/plain

Exemplo de resposta

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

Campo	Descrição
enititymap_id	Identificador da configuração do mapa de entidades
entitytype	Tipo de entidade no sistema pdk - cartão “controle” arrangement - cartão “acordo”
role	Papel do usuário no sistema
system_field_name	Системное название поле
action_tasktype	Tipo de tarefa (por exemplo, Reunião, Treinamento, Trabalho administrativo)
ui_field_name	Nome exibido ao usuário na interface

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400	Requisição inválida
401	Não autorizado (token inválido ou ausente)
500	Erro interno do servidor

Pesquisa