Modificar dados do formulário de solicitações

Como copiar valores de campos de formulário entre instâncias utilizando as API's do Zeev?

Para copiar valores de campos de formulário entre instâncias utilizando as API's do Zeev, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Obtenha o Id dados da instância de origem: O Id é o código único da solicitação, você pode encontrar ele buscando em monitorar -> solicitações, ou utilizando o endpoint de API do Zeev para consultar instâncias através de filtros conforme descrito em Listar todas as solicitações do sistema.
Prepare os dados para a instância de destino: Como no passo anterior, encontre o Id da instância para qual você deseja copiar os dados.
Atualize a instância de destino: Use o endpoint Modificar dados do formulário de solicitações para atualizar os campos da instância de destino substituindo os parâmetros pelos dados obtidos nas consultas dos passos 2 e 3 (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev).

Copia os valores de campos de formulário entre instâncias (Auth)

patch

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

fromInstanceIdinteger · int32Obrigatório

Código identificador da instância original

toInstanceIdinteger · int32Obrigatório

Código identificador da instância de destino

Respostas

200

Sucesso

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch

/api/2/formvalues/{frominstanceid}/copy-to/{toinstanceid}

PATCH /api/2/formvalues/{frominstanceid}/copy-to/{toinstanceid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Exemplos de requisição

let fromInstanceId = 1234; //Id da solicitação de origem obtido por outra chamada de API ou informado manualmente
let toInstanceId = 4321; //Id da solicitação de destino obtido por outra chamada de API ou informado manualmente

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


const raw = "";

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

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/formvalues/${fromInstanceId}/copy-to/${toInstanceId}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Como modificar valores os dados de campos de uma instância utilizando as API's do Zeev?

Para modificar valores de campos de uma instância utilizando as API's do Zeev, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
O Id é o código único da solicitação, você pode encontrar ele buscando em monitorar -> solicitações, ou utilizando o endpoint de API do Zeev para consultar instâncias através de filtros conforme descrito em Listar todas as solicitações do sistema.
Prepare os dados a serem atualizados: Identifique os campos e os novos valores que serão atribuídos na instância selecionada.
Atualize os campos da instância: Utilize o endpoint Modificar dados do formulário de solicitações para alterar os valores dos campos, enviando a requisição com os novos dados e o Id da instância alvo, confira abaixo os detalhes e modelos de requisição (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev).

Atualizar campos de formulário da instância (Auth)

patch

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

instanceIdinteger · int32Obrigatório

Código identificador da instância da solicitação

Corpo

updateClosedInstancebooleanOpcional

Atualiza a solicitação mesmo que já esteja finalizada.

Respostas

200

Sucesso

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch

/api/2/formvalues/{instanceid}

PATCH /api/2/formvalues/{instanceid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "formValues": [
    {
      "name": "razaoSocial",
      "value": "SML",
      "row": 1
    },
    {
      "name": "cidade",
      "value": "São Paulo",
      "row": 1
    }
  ],
  "updateClosedInstance": false
}

{
  "success": true
}

Exemplos de requisição

//Id da instancia em que os dados serão atualizados obtido através de API ou informado manualmente
let instanceId = 1234; 

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({
  "formValues": [
    {
      "name": "razaoSocial",
      "value": "SML",
      "row": 1
    },
    {
      "name": "cidade",
      "value": "São Paulo",
      "row": 1
    }
  ],
  "updateClosedInstance": false
});

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

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

Como apagar o histórico de campos de uma instância utilizando as API's do Zeev?

Para apagar o histórico de campos de uma instância utilizando as API's do Zeev, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Obtenha o Id dados da instância de origem: O ID é o código único da solicitação, você pode encontrar ele buscando em monitorar -> solicitações, ou utilizando o endpoint de API do Zeev para consultar instâncias através de filtros conforme descrito em Listar todas as solicitações do sistema.
Prepare os dados a serem atualizados: Identifique os campos que terão o histórico apagado na instância selecionada.
Apague o histórico dos campos da instância: Utilize o endpoint PATCH /api/2/formvalues/{instanceid} /history/clear para apagar o histórico dos campos, enviando a requisição com a lista de nomes de campos da instância alvo, confira abaixo os detalhes e modelos de requisição (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev).

Apaga o histórico do preenchimento dos campos do formulário em todas as tarefas concluídas, se o campo estiver em tabela todas as linhas serão apagadas (Auth)

patch

https://kb.zeev.it/apis/all/instances/form-fields

Autorizações

AuthorizationstringObrigatório

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

Parâmetros de rota

instanceIdinteger · int32Obrigatório

Código identificador da instância da solicitação

Corpo

fieldListstring[]Obrigatório

Lista de campos

deleteEvenIfThereIsASignaturebooleanObrigatório

Apagar histórico mesmo que haja assinatura eletrônica na instância.

Respostas

200

Sucesso

400

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

401

Pessoa não autorizada

403

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

404

O registro não foi encontrado

429

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

500

Ocorreu algum erro interno no servidor

patch

/api/2/formvalues/{instanceid}/history/clear

PATCH /api/2/formvalues/{instanceid}/history/clear HTTP/1.1
Host: candidate-zeev.zeev.app
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "fieldList": [
    "razaoSocial",
    "cidade"
  ],
  "deleteEvenIfThereIsASignature": false
}

{
  "success": true
}

Links relacionados:

AnteriorCriar / abrir solicitações via API PróximoListar ou adicionar mensagens em solicitação

Atualizado há 5 meses