Listar funções

Como listar as funções utilizando API?

Para listar as funções cadastradas no Zeev, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Enviar requisição: Utilize o endpoint Listar funções;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $select, $orderby e $top.

Serão listadas as funções acessíveis pela pessoa autenticada na API.

Listar funções que a pessoa relacionada ao token tem permissão de visualizar (Auth)

get

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisiçã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

GET /api/2/positions 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
  }
]

Exemplo de requisição para listar as posições cadastradas no Zeev

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", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

// Se desejar aplicar algum filtro utilize oData conforme exemplo abaixo
let urlAddress = "https://seu_endereco.do.zeev/api/2/positions";
let oDataFilter = "filter=contains(name,'Analista')" //Filtra funções que contenham a palavra Analista no nome

try {
  const response = await fetch(`${urlAddress}/?${oDataFilter}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Links relacionados:

AnteriorFunções PróximoConsultar função

Atualizado há 1 ano

hashtagComo listar as funções utilizando API?

hashtagListar funções que a pessoa relacionada ao token tem permissão de visualizar (Auth)

hashtagLinks relacionados:

Como listar as funções utilizando API?

Listar funções que a pessoa relacionada ao token tem permissão de visualizar (Auth)

Links relacionados: