Consultar grupo

Como obter os dados de um grupo de manutenção via API pelo código identificador?

Para obter os dados de um grupo de manutenção via API pelo código identificador, siga estes passos:

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

2. Obtenha o groupid: Este é o código identificador do grupo de manutenção. É possível encontra-lo na página Avançado > Grupos de permissões ou através de requisições de API como em Consultar grupo;

3. Enviar requisição: Utilize o endpoint Consultar grupo para obter o grupo desejado;

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Obter grupo de manutenção pelo código identificador (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 do grupo

codestringOpcional

Código original / Integração

namestringOpcional

Nome do grupo

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}

HTTPcURLJavaScriptPython

GET /api/2/groups/{groupid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "code": "text",
  "name": "text"
}

Exemplo de requisição para obter os grupos de manutenção

Node.js

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 {
myHeaders.append("Content-Type", "application/json");
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/groups/${groupId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como obter os dados de um grupo de manutenção via API pelo código original / integração?

Para obter os dados de um grupo de manutenção via API pelo código identificador, siga estes passos:

1. Autenticação: Primeiro obtenha um token de autenticação;

2. Obtenha o groupcode: Este é o código identificador do grupo de manutenção. É possível encontra-lo na página Avançado > Grupos de permissões ao editar um grupo, ou através de requisições de API como em Consultar grupo

3. Enviar requisição: Utilize o endpoint Consultar grupo para obter o grupo desejado;

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Obter grupo de manutenção pelo código 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 original / integração do grupo

Respostas

200

Sucesso

application/jsontext/jsontext/xml

idinteger · int32Opcional

Identificador do grupo

codestringOpcional

Código original / Integração

namestringOpcional

Nome do grupo

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}

HTTPcURLJavaScriptPython

GET /api/2/groups/code/{groupcode} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "code": "text",
  "name": "text"
}

Exemplo de requisição para obter os grupos de manutenção

Node.js

let groupCode = "grP0Adm"

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,
  redirect: "follow"
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/groups/code/${groupCode}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---