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

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

groupIdinteger · int32Obrigatório

Identificador do grupo

Respostas

200

Sucesso

application/jsontext/jsontext/xml

idinteger · int32Opcional

Identificador da pessoa cadastrada no Zeev

namestringOpcional

Nome da pessoa

usernamestringOpcional

Login da pessoa

emailstringOpcional

Email da pessoa

isActivebooleanOpcional

Pessoa ativa no cadastro

licenseTypestringOpcional

Tipo de licença

400

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

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

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

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

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

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/groups/{groupid}/users

HTTPcURLJavaScriptPython

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

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

groupCodestringObrigatório

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

Respostas

200

Sucesso

application/jsontext/jsontext/xml

idinteger · int32Opcional

Identificador da pessoa cadastrada no Zeev

namestringOpcional

Nome da pessoa

usernamestringOpcional

Login da pessoa

emailstringOpcional

Email da pessoa

isActivebooleanOpcional

Pessoa ativa no cadastro

licenseTypestringOpcional

Tipo de licença

400

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

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

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

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

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

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/groups/code/{groupcode}/users

HTTPcURLJavaScriptPython

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

Node.js (Exemplo utilizando groupid)

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);
};

Node.js (Exemplo utilizando groupcode)

---

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Gerenciar pessoas

• Como criar grupos de permissões

• Para que grupos são usados