--- title: Webservices - 4biz Builder slug: developer/webservices-4biz-builder description: This document provides essential knowledge and guidelines for utilizing Rest services. Learn how to access the Rest API, including authentication with a token. Discover examples and instructions for managing business objects, retrieving metadata, and exec createdAt: 2022-02-10T15:42:34.000Z --- Este documento reúne os conhecimentos mínimos necessários para o adequado uso dos serviços via Rest. | **URL** | **Descrição** | **Parâmetros** | **Retorna** | | ------------------------------------------------- | ------------------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------- | | **/execute/{name}** | Inicia um fluxo ESI a partir do nome. | name: Nome do fluxo cadastrado. | Objeto representativo do fluxo cadastrado. | | **/instance/initialize/{processInstanceId}** | Recupera os valores de uma instância de processo. | processInstanceid: ID da instância de processo. | Objeto representativo da instância de processo cadastrada. | | | | | | | **/instance/suspend/{processInstanceId}** | Suspende uma instância de processo. | processInstanceid: ID da instância de processo. | Objeto representativo da instância de processo cadastrada. | | **/instance/restart/{processInstanceId}** | Reinicia uma instância de processo | processInstanceid: ID da instância de processo | Objeto representativo da instância de processo cadastrada | | **/instance/reopen/{processInstanceId}** | Reabre uma instância de processo. | processInstanceid: ID da instância de processo. | Objeto representativo da instância de processo cadastrada. | | **/userTask/{userTaskId}** | Recupera uma tarefa de usuário. | userTaskId: ID da tarefa de usuário criada. | Objeto representativo da instância de processo cadastrada. | | **/rule/executeWithMap/{name}** | Executa uma regra de negócio. | name: Nome da regra de negócio cadastrada. | Objeto representativo da regra de negócio executada. | - request body: JSON Objeto com variáveis para o fluxo - request body: JSON Objeto com variáveis para regras de negócio *Tabela 1 - Especificação das APPLICATION PROGRAMMABLE INTERFACES (APIs)* ## Orientações específicas para acesso à API Rest Nas seções seguintes, está detalhado cada tipo de uso previsto para os serviços disponíveis via Rest no produto 4biz Enteprise Builder. ### Autenticação Para usar as APIs, o cliente deve estar logado no Builder. Para isso, basta obter um token a partir do serviço de autenticação e injetar esse token no header de cada requisição REST com o identificador authentication-token. A autenticação é feita através do serviço POST **/cit-esi-web/token**, passando um objeto JSON com os atributos username e password no body. ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/qBg3OuwJWiJjY4LjyjjsI_9181.png) Figura 1 - Exemplo utilizando o plugin Restlet Client do Chrome ### API REST de objetos de negócio Cada objeto de negócio disponibiliza um conjunto de serviços REST que pode ser consumido a partir da URL **/cit-esi-web/dynamic/\{nome da aplicação}/\{nome do objeto de negócio}**. São serviços básicos de criação, atualização, listagem e exclusão do objeto de negócio, além de um método getStructure que retorna o metadado do objeto de negócio. Cada SQL criado no objeto de negócio também pode ser chamado na forma de método. Seguem exemplos utilizando o objeto de negócio hotel da aplicação hotéis. Para cada requisição, deve ser fornecido o authentication-token obtido no serviço de login. A url deve terminar com “.json”. ### Inclusão de objeto de negócio - **HTTP verb**: POST - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}.json - **Body**: JSON contendo os atributos do registro do objeto de negócio a ser incluído ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/NE-gEC9KkeE4jl2zncqRs_9182.png) Figura 2 - Inclusão de objeto de negócio ### Alteração de objeto de negócio - **HTTP verb**: POST - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}/update.json - **Body**: JSON contendo os atributos do registro do objeto de negócio a ser alterado. ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/IUwfAhlmt4uhc8lzMXniI_9183.png) Figura 3 - Mudança de objeto de negócio ### Exclusão de objeto de negócio - **HTTP verb**: POST - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}/remove.json - **Body**: JSON contendo a chave primária do registro do objeto de negócio a ser excluído ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/snoOWLS7QM-whKE54efFx_9184.png) Figura 4 - Exclusão de objeto de negócio ### Listagem de objetos de negócio - **HTTP verb**: GET - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}.json ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/J5M4py1wlWkYP_nYUuR1E_9185.png) Figura 5 - Listagem de objetos de negócio ### Recuperação de objeto de negócio pela chave primária - **HTTP verb**: POST - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}/restore.json - **Body**: JSON contendo: - A chave primária do registro do objeto de negócio a ser excluído. - Atributo boolean findManyToOne, indicando se o sistema deve recuperar os relacionamentos muitos para um do objeto. - Atributo boolean findOneToMany, indicando se o sistema deve recuperar os relacionamentos um para muitos do objeto. ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/rGCljLcADF2EVs_4qrEor_9186.png) Figura 6 - Recuperação de objeto de negócio pela chave primária. ### Recuperação da estrutura do objeto de negócio - **HTTP verb**: GET - **URL**: /cit-esi-web/rest/dynamic/\{application name}/\{business object name}/getStructure.json ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/INqxMT6-GW11uJH_3RcNZ_9187.png) Figura 7 - Recuperação da estrutura do objeto de negócio ### SQL Execução de objeto de negócio - **HTTP verb**: POST - **URL**: / cit-esi-web / rest / dynamic / \{application name} / \{business object name} /list.son - **Body**: JSON contendo: - Atributo SQLName com o nome do SQL a ser executado; - Atributo JSON dynamicModel contendo os valores dos parâmetros esperados no SQL; - Atributo boolean findManyToOne (opcional), indicando se o sistema deve recuperar os relacionamentos muitos para um do objeto; - Atributo boolean findOneToMany (opcional), indicando se o sistema deve recuperar os relacionamentos um para muitos do objeto. ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/5cVQClC17RYcA2-fXg3FA_9188.png) Figura 8 - Execução de SQL do objeto de negócio ### Execução de fluxos ESI Qualquer fluxo ESI pode ser executado via REST utilizando o serviço POST */cit-esi-web/rest/esi/execute/\{nome do fluxo}*. Para cada requisição, deve ser fornecido o authentication-token obtido no serviço de login. No corpo (body) da requisição deve ser fornecido um JSON contendo as variáveis de entrada necessárias à execução do fluxo. O exemplo abaixo executa o fluxo busca\_empregado, fornecendo a matricula “12345” como variável de entrada do fluxo. O fluxo retorna o objeto JSON “empregado”. ![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/MrIBJ_zGS-wVzIU222Lhq_9189.png) Figura 9 - Exemplo de execução de fluxos ESI