Listar pessoas da função

Como listar as pessoas vinculadas a uma função utilizando API?

Para listar as pessoas vinculadas a uma função, siga estes passos:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Enviar requisição: Utilize o endpoint Listar pessoas da função;

3. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $select, $orderby e $top.

Listar as pessoas associadas a essa função (Auth)

get

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

positionCodestringObrigatório

Código original / integração da função

Respostas

200

Sucesso

idinteger · int32Opcional

Identificador da pessoa

namestringOpcional

Nome da pessoa

usernamestringOpcional

Login da pessoa

emailstringOpcional

Endereço de e-mail da pessoa

isActivebooleanOpcional

Indica se o cadastro da pessoa está ativo

licenseTypestringOpcional

Tipo de licença da pessoa

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/code/{positioncode}/users

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

[
  {
    "id": 1,
    "name": "text",
    "username": "text",
    "email": "text",
    "isActive": true,
    "licenseType": "text",
    "position": {
      "id": 1,
      "name": "text",
      "code": "text"
    },
    "team": {
      "id": 1,
      "name": "text",
      "code": "text"
    }
  }
]

Exemplo de requisição para listar as pessoas vinculadas a uma função

Node.js

let positionCode = "p0s1Tion";

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/${positionCode}/users`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---