Consultar função

Como obter uma função específica utilizando API?

É possível obter os dados de uma função específica utilizando API através de dois endpoints diferentes:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Utilize:
- Consultar função se desejar obter a função utilizando como filtro o parâmetro positionid que é o código identificaor da função;
- Consultar função se desejar obter a função utilizando como filtro o parâmetro postioncode que é o código original/integração da função;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Tanto o código identificador quanto o código original podem ser obtidos na página Acesso > Funções ou através de consultas de API como em Consultar função

Obter função específica pelo código (Auth)

get

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

positionIdinteger · int32Obrigatório

Identificador da função / posição

Respostas

200

Sucesso

idinteger · int32Opcional

Identificador da função

codestringOpcional

Código original / Integração

namestringOpcional

Nome da função

levelstringOpcional

Relação de níveis hierarquicos

parentIdinteger · int32Opcional

Identificador da função de nível hierarquico superior

descriptionstringOpcional

Descrição da função

activebooleanOpcional

Indica se a função está ativa

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get

/api/2/positions/{positionid}

GET /api/2/positions/{positionid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "code": "text",
  "name": "text",
  "level": "text",
  "parentId": 1,
  "description": "text",
  "active": true
}

Obter função pelo código original / integração (Auth)

get