Criar, ativar e desativar funções

Como criar uma função no Zeev utilizando API?

Para criar uma função 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 e o código original que são respectivamente os valores de name, description e code;

  3. Obtenha o parentId: Se desejar informar uma função superior hierarquicamente, obtenha antes o parentId que é o código identificador (positionid) da função hierarquicamente superior. É possível obtê-lo na página Acesso > Funções ou através de consultas de API como em Criar, ativar e desativar funções;

  4. Obtenha o teamId: É o identificador do time a que a função pertence. É possível obtê-lo através da página Acesso > Times do Zeev ou através de consultas de API como descrito em Listar times;

  5. Obtenha o type: Este é o tipo de função. Atualmente não há Api's para listar os tipos de função disponíveis para esta propriedade. Você deve obter o valor desejado consultando a página Avançado > Tipos de funções;

  6. Utilize o endpoint Criar, ativar e desativar funções para enviar a requisição;

Criar uma função (Auth)

post
Autorizações
Corpo
activebooleanOpcional

Indica se a função está ativa ou não para ser utilizada. Padrão: true

codestringOpcional

Identificador da função utilizado em APIs, integrações e customizações

descriptionstringOpcional

Descrição da função

namestringObrigatório

Nome da função

parentIdinteger · int32Opcional

Identificador da função superior

teamIdinteger · int32Opcional

Identificador do time para associar com a função

typeinteger · int32Opcional

Identificador do tipo da função

Respostas
200

Sucesso

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

{
  "active": true,
  "code": "text",
  "description": "text",
  "name": "text",
  "parentId": 1,
  "teamId": 1,
  "type": 1
}
{
  "id": 1
}

Exemplo de requisição para criar uma função 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": "Analista de sistemas",
  "active": true,
  "code": "FnAn4l1staSis",
  "description": "Aqui estarão vinculadas pessoas analistas de sistemas",
  "parentId": 98549004, //informe se desejar vincular uma função hierarquicamente superior
  "teamId": 951753, //Código identificador do time
  "type": 118 //Código identificador do tipo de função
});

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

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

Como ativar/desativar uma função no Zeev?

Para ativar ou desativar uma função no Zeev utilizando API siga os passos abaixo:

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

  2. Obtenha a positionid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Funções ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar funções;

  3. Para desativar a função: Envie a requisição para Criar, ativar e desativar funções (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

  4. Para ativar a função: Envie a requisição para Criar, ativar e desativar funções (troque seu_endereco.do.zeev pelo endereço que você utiliza para acessar o Zeev);

Ativar uma função pelo identificador (Auth)

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

Identificador da função / posição

Respostas
200

Sucesso

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

{
  "success": true
}

Desativar uma função pelo identificador (Auth)

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

Identificador da função / posição

Respostas
200

Sucesso

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

{
  "success": true
}

Exemplo de requisição para ativar / desativar funções

let positionId = 753;

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: "PATCH",
  headers: myHeaders
};

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

Links relacionados:

AnteriorListar pessoas da funçãoPróximoPessoas

Atualizado