Listar elementos do aplicativo

Como listar os elementos que compõem um aplicativo utilizando API?

Se você precisar listar os elementos que compõem um aplicativo utilizando API's, 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 elementos 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);

Lista os elementos que compoem o design do 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

tasksobject · Orquestra.Models.Base.ApiModels.Suport.IModelResult[]Somente leituraOpcional

Relação dos elementos que compõem o aplicativo

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/elements

HTTPcURLJavaScriptPython

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

{
  "tasks": [
    {
      "type": "Tarefa Humana",
      "flowId": 100,
      "taskId": 1000,
      "page": 1,
      "title": "Atividade 1",
      "description": null,
      "requiredFiles": null,
      "editableFields": [
        "nome",
        "idade"
      ],
      "buttons": [
        "Concluir",
        "Não concluir"
      ],
      "responsible": "Requisitante",
      "users": null,
      "timeout": 8,
      "businessHour": true,
      "email": true,
      "posX": 320,
      "posY": 310
    }
  ]
}

Exemplo de requisição para listar os elementos que compõem o aplicativo

Node.js

let flowId = 100;

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