Listar campos do formulário do aplicativo

Como listar os campos de formulário associados a um aplicativo utilizando API?

Para obter os campos associados a uma aplicação 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. Obtenha o flowId: Obtenha o código identificador do aplicativo, você pode fazer isso explorando o Zeev na página Construir > Aplicativos ou utilizando alguma API como por exemplo esta. Após obter o flowId;

3. Enviar a Requisição: Utilize o endpoint Listar campos do formulário do aplicativo para enviar a requisição conforme modelo e exemplo (Troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev e {flowId} pelo código identificador do aplicativo);

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

Lista os campos de formularios associados ao aplicativo (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

flowIdinteger · int32Obrigatório

Código identificador do aplicativo

Respostas

200

Sucesso

application/jsontext/jsontext/xml

flowIdinteger · int32Opcional

Código identificador do aplicativo

fieldIdinteger · int32Opcional

Código identificador do campo

groupNamestringOpcional

Grupo à que o campo pertence

namestringOpcional

Identificador do campo

labelstringOpcional

Nome do campo conforme apresentado no formulário

typeNamestringOpcional

Tipo de campo

requiredbooleanOpcional

Indica se o preenchimento do campo é obrigatório nas atividades em que está habilitado

validationNamestringOpcional

Validação especial

minLengthstringOpcional

Mínimo de caracteres do campo

maxLengthstringOpcional

Máximo de caracteres do campo

integrationIdinteger · int32Opcional

Id da integração associada ao campo

integrationNamestringOpcional

Nome da integração associada ao campo

attributesstring[]Opcional

Opções disponíveis para seleção

tasksstring[]Opcional

Relação de atividades em que o campo está habilitado para uso

actionScriptstringOpcional

Scripts criados diretamente no campo

groupOrderinteger · int32Opcional

Ordenação do grupo do campo

rowOrderinteger · int32Opcional

Ordenação do campo dentro do agrupamento

columnOrderinteger · int32Opcional

Ordenação da coluna do campo

orderinteger · int32Opcional

Ordenação geral do campo

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/flows/{flowid}/design/form

HTTPcURLJavaScriptPython

GET /api/2/flows/{flowid}/design/form HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "flowId": 1,
  "fieldId": 1,
  "groupName": "text",
  "name": "text",
  "label": "text",
  "typeName": "text",
  "required": true,
  "validationName": "text",
  "minLength": "text",
  "maxLength": "text",
  "integrationId": 1,
  "integrationName": "text",
  "attributes": [
    "text"
  ],
  "tasks": [
    "text"
  ],
  "actionScript": "text",
  "groupOrder": 1,
  "rowOrder": 1,
  "columnOrder": 1,
  "order": 1
}

Exemplo de requisição para obter os campos associados ao formulário do aplicativo

Node.js

let flowId = 1599;

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/flows/${flowId}/design/form`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};