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
Identificador da função / posição
Sucesso
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
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
}Código original / integração da posição
Sucesso
Solicitação ou dados da solicitação são inválidas
Pessoa não autorizada
Pessoa não tem permissão de executar essa operação
O registro não foi encontrado
Muitas requisições em um determinado período de tempo
Ocorreu algum erro interno no servidor
GET /api/2/positions/code/{positioncode} 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
}Exemplos de requisição para obter dados de uma função específica
let positionId = 573;
const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");
const requestOptions = {
method: "GET",
headers: myHeaders
};
try {
const response = await fetch(`https://seu_endereco.do.zeev/api/2/positions/code/${positionId}/users`, requestOptions);
const result = await response.json();
console.log(result)
} catch (error) {
console.error(error);
};Atualizado