Webservices - CITSmart Neuro

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 citsmart enteprise neuro autenticação para usar as apis, o cliente deve estar logado no neuro 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 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 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 atributosdo registro do objeto de negócio a ser alterado figure 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 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 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 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 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 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” figura 9 exemplo de execução de fluxos esi