Listar pessoas do grupo

Como listar pessoas vinculadas a um grupo de manutenção utilizando API?

É possível listar as pessoas vinculadas à um grupo de manutenção através de dois endpoints diferentes:

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

  • Utilize:

    • Listar pessoas do grupose desejar filtrar a consulta pelo groupid (código identificador do grupo) para realizar a requisição.

    • Listar pessoas do grupo se desejar filtrar a consulta pelo groupcode (Código original / Integração)l

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

É possível encontrar tanto o código identificador quanto o código original na página Avançado > Grupos de permissões ou através de requisições de API como em Listar pessoas do grupo

Listar as pessoas vinculadas ao grupo (Auth)

get
Autorizações
Parâmetros de rota
groupIdinteger · int32Obrigatório

Identificador do grupo

Respostas
200

Sucesso

get
GET /api/2/groups/{groupid}/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"
}

Listar as pessoas vinculadas ao grupo por código de original / integração (Auth)

get
Autorizações
Parâmetros de rota
groupCodestringObrigatório

Código de original / integração do grupo

Respostas
200

Sucesso

get
GET /api/2/groups/code/{groupcode}/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"
  }
]

Exemplos de requisição para obter os usuários vinculados a um grupo

let groupId = 852;

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

Links relacionados:

AnteriorConsultar grupoPróximoListar permissões do grupo

Atualizado