Criar, ativar e desativar times

Como criar um time utilizando API?

Para criar um time no Zeev utilizando API, siga os passos abaixo:

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

  2. Defina os valores dos parâmetros: Defina o nome, a descrição, o código original e a sigla do time que são respectivamente os valores de name, description, code e sign;

  3. Defina o valor de alwaysVisible: Se for definido como true esse time aparecerá no menu lateral de "Acompanhar solicitações", mesmo que ele não possua nenhum aplicativo ou serviço disponível.

  4. Obtenha o parentId: Se desejar informar um time superior hierarquicamente, obtenha antes o parentId que é o código identificador (teamid) do time hierarquicamente superior. É possível obtê-lo na página Acesso > Times ou através de consultas de API como explicado em Listar times;

  5. Obtenha o cityId: Este é código identificador da cidade.É possível encontrar este valor consultando a página Avançado > Cidades ou através de consultas de API como explicado em Outros. Para entender como a associação de uma cidade impacta o time consulte Turnos de trabalho e cidades;

  6. Obtenha o type: Não é uma propriedade obrigatória mas ajuda a organizar e identificar os times. Não há no momento API's que possam listar os tipos de times disponíveis, você pode encontrar os valores na página Avançado > Tipos de times;;

  7. Utilize o endpoint Criar, ativar e desativar times para enviar a requisição;

Criar um time (Auth)

post
Autorizações
Corpo
activebooleanOpcional

Indica se o time está ativo ou não para ser utilizado. Padrão: true

alwaysVisiblebooleanOpcional

Indica se o time é apresentado mesmo quando não há aplicativo ou serviço vinculados a ele. Padrão: false

cityIdinteger · int32Opcional

Identificador da cidade

codestringOpcional

Identificador do time utilizado em APIs, integrações e customizações

descriptionstringOpcional

Descrição do time

namestringObrigatório

Nome do time

parentIdinteger · int32Opcional

Identificador do time superior

signstringOpcional

Sigla do time

typeinteger · int32Opcional

Identificador do tipo do time

Respostas
200

Sucesso

post
POST /api/2/teams HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "active": true,
  "alwaysVisible": true,
  "cityId": 1,
  "code": "text",
  "description": "text",
  "name": "text",
  "parentId": 1,
  "sign": "text",
  "type": 1
}
{
  "id": 1
}

Exemplo de requisição para criar um time 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 raw = JSON.stringify({
  "name": "Projetos",
  "active": true,
  "alwaysVisible": true,
  "cityId": 14109,
  "code": "Pr0j3t0s-ab0",
  "description": "Time de projetos",
  "parentId": 64594592,
  "sign": "PJT",
  "type": 51564961
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/teams", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Como ativar/desativar um time utilizando API?

Para ativar ou desativar um time no Zeev utilizando API siga os passos abaixo:

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

  2. Obter o teamId: Obtenha o código identificador do time, você pode encontra-lo na página Acesso > Times ou no o resultado de consultas de API como explicado em Listar times;

  3. Enviar a requisição para:

    1. Ativar o time: Criar, ativar e desativar times

    2. Desativar o time: Criar, ativar e desativar times

Lembre-se de substituir seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev.

Ativar um time pelo identificador (Auth)

patch
Autorizações
Parâmetros de rota
teamIdinteger · int32Obrigatório

Identificador do time

Respostas
200

Sucesso

patch
PATCH /api/2/teams/{teamid}/activate HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Desativar um time pelo identificador (Auth)

patch
Autorizações
Parâmetros de rota
teamIdinteger · int32Obrigatório

Identificador do time

Respostas
200

Sucesso

patch
PATCH /api/2/teams/{teamid}/deactivate HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Exemplos de requisição para ativar/desativar um time?

let teamId = 751;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "PATCH",
  headers: myHeaders
};

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

Links relacionados:

AnteriorListar funções do timePróximoSolicitações

Atualizado