Informatica MDM Multidomain Edition (Versão ) Guia de Serviços de Entidade Comercial

Transcrição

1 Informatica MDM Multidomain Edition (Versão ) Guia de Serviços de Entidade Comercial

2 Informatica MDM Multidomain Edition Guia de Serviços de Entidade Comercial Versão Novembro 2015 Copyright (c) Informatica LLC. Todos os direitos reservados. Este software e a respectiva documentação contêm informações de propriedade da Informatica LLC. Eles são fornecidos sob um contrato de licença que contém restrições quanto a seu uso e divulgação, e são protegidos por leis de copyright. A engenharia reversa do software é proibida. Não está permitida de forma alguma a reprodução ou a transmissão de qualquer parte deste documento (seja por meio eletrônico, fotocópia, gravação ou quaisquer outros) sem o consentimento prévio da Informatica LLC. Este Software pode estar protegido por patentes dos EUA e/ou internacionais e outras patentes pendentes. O uso, duplicação ou divulgação do Software pelo Governo dos Estados Unidos estão sujeitos às restrições estipuladas no contrato de licença de software aplicável e como estabelecido em DFARS (a) e (a) (1995), DFARS (1)(ii) (OCT 1988), FAR (a) (1995), FAR ou FAR (ALT III), conforme aplicável. As informações contidas neste produto ou documentação estão sujeitas a alteração sem aviso prévio. Informe-nos por escrito caso encontre quaisquer problemas neste produto ou documentação. Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging e Informatica Master Data Management são marcas comerciais ou marcas registradas da Informatica LLC nos Estados Unidos e em jurisdições pelo mundo. Todos os outros nomes de outras companhias e produtos podem ser nomes ou marcas comerciais de seus respectivos proprietários. Partes desta documentação e/ou software estão sujeitas a direitos autorais de terceiros, incluindo sem limitação: Copyright DataDirect Technologies. Todos os direitos reservados. Copyright Sun Microsystems. Todos os direitos reservados. Copyright RSA Security Inc. Todos os direitos reservados. Copyright Ordinal Technology Corp. Todos os direitos reservados. Copyright Aandacht c.v. Todos os direitos reservados. Copyright Genivia, Inc. Todos os direitos reservados. Copyright Isomorphic Software. Todos os direitos reservados. Copyright Meta Integration Technology, Inc. Todos os direitos reservados. Copyright Intalio. Todos os direitos reservados. Copyright Oracle. Todos os direitos reservados. Copyright Adobe Systems Incorporated. Todos os direitos reservados. Copyright DataArt, Inc. Todos os direitos reservados. Copyright ComponentSource. Todos os direitos reservados. Copyright Microsoft Corporation. Todos os direitos reservados. Copyright Rogue Wave Software, Inc. Todos os direitos reservados. Copyright Teradata Corporation. Todos os direitos reservados. Copyright Yahoo! Inc. Todos os direitos reservados. Copyright Glyph & Cog, LLC. Todos os direitos reservados. Copyright Thinkmap, Inc. Todos os direitos reservados. Copyright Clearpace Software Limited. Todos os direitos reservados. Copyright Information Builders, Inc. Todos os direitos reservados. Copyright OSS Nokalva, Inc. Todos os direitos reservados. Copyright Edifecs, Inc. Todos os direitos reservados. Copyright Cleo Communications, Inc. Todos os direitos reservados. Copyright International Organization for Standardization Todos os direitos reservados. Copyright ej-technologies GmbH.Todos os direitos reservados. Copyright Jaspersoft Corporation. Todos os direitos reservados. Copyright International Business Machines Corporation. Todos os direitos reservados. Copyright yworks GmbH. Todos os direitos reservados. Copyright Lucent Technologies.Todos os direitos reservados. Copyright University of Toronto. Todos os direitos reservados. Copyright Daniel Veillard.Todos os direitos reservados. Copyright Unicode, Inc. Copyright IBM Corp. Todos os direitos reservados. Copyright MicroQuill Software Publishing, Inc. Todos os direitos reservados. Copyright PassMark Software Pty Ltd. Todos os direitos reservados. Copyright LogiXML, Inc. Todos os direitos reservados. Copyright Lorenzi Davide, todos os direitos reservados. Copyright Red Hat, Inc. Todos os direitos reservados. Copyright The Board of Trustees of the Leland Stanford Junior University. Todos os direitos reservados. Copyright EMC Corporation. Todos os direitos reservados. Copyright Flexera Software.Todos os direitos reservados. Copyright Jinfonet Software. Todos os direitos reservados. Copyright Apple Inc. Todos os direitos reservados. Copyright Telerik Inc. Todos os direitos reservados. Copyright BEA Systems. Todos os direitos reservados. Copyright PDFlib GmbH. Todos os direitos reservados. Copyright Orientation in Objects GmbH. Todos os direitos reservados. Copyright Tanuki Software, Ltd. Todos os direitos reservados. Copyright Ricebridge. Todos os direitos reservados. Copyright Sencha, Inc. Todos os direitos reservados. Copyright Scalable Systems, Inc. Todos os direitos reservados. Copyright jqwidgets. Todos os direitos reservados. Copyright Tableau Software, Inc. Todos os direitos reservados. Copyright MaxMind, Inc. Todos os direitos reservados. Copyright TMate Software s.r.o. Todos os direitos reservados. Copyright MapR Technologies Inc. Todos os direitos reservados. Copyright Amazon Corporate LLC. Todos os direitos reservados. Copyright Highsoft. Todos os direitos reservados. Copyright Python Software Foundation. Todos os direitos reservados. Copyright BeOpen.com. Todos os direitos reservados. Copyright CNRI. Todos os direitos reservados. Este produto inclui software desenvolvido pela Apache Software Foundation ( e/ou outros softwares licenciados nas várias versões da Licença Apache (a "Licença"). Você pode obter uma cópia dessas Licenças em A menos que exigido pela legislação aplicável ou concordado por escrito, o software distribuído em conformidade com estas Licenças é fornecido "NO ESTADO EM QUE SE ENCONTRA", SEM GARANTIA OU CONDIÇÃO DE QUALQUER TIPO, seja expressa ou implícita. Consulte as Licenças para conhecer as limitações e as permissões que regulam o idioma específico de acordo com as Licenças. Este produto inclui software desenvolvido pela Mozilla ( direitos autorais de software de The JBoss Group, LLC; todos os direitos reservados; software copyright de Bruno Lowagie e Paulo Soares e outros produtos de software licenciados sob a Licença Pública GNU Lesser General Public License Agreement, que pode ser encontrada em Os materiais são fornecidos gratuitamente pela Informatica, no estado em que se encontram, sem garantia de qualquer tipo, explícita nem implícita, incluindo, mas não limitando-se, as garantias implicadas de comerciabilidade e adequação a um determinado propósito. O produto inclui software ACE(TM) e TAO(TM) com copyright de Douglas C. Schmidt e seu grupo de pesquisa na Washington University, University of California, Irvine e Vanderbilt University, Copyright ( ) , todos os direitos reservados. Este produto inclui o software desenvolvido pelo OpenSSL Project para ser usado no kit de ferramentas OpenSSL (copyright The OpenSSL Project. Todos os direitos reservados) e a redistribuição deste software está sujeita aos termos disponíveis em e Este produto inclui o software Curl com o Copyright , Daniel Stenberg, <daniel@haxx.se>. Todos os direitos reservados. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em É permitido usar, copiar, modificar e distribuir este software com qualquer objetivo, com ou sem taxa, desde que a nota de direitos autorais acima e esta nota de permissão apareçam em todas as cópias. O produto inclui software copyright ( ) MetaStuff, Ltd. Todos os direitos reservados. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em O produto inclui o copyright de software , The Dojo Foundation. Todos os direitos reservados. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em Este produto inclui o software ICU com o copyright International Business Machines Corporation e outros. Todos os direitos reservados. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em Este produto inclui o copyright de software Per Bothner. Todos os direitos reservados. O direito de usar tais materiais é estabelecido na licença que pode ser encontrada em Este produto inclui o software OSSP UUID com Copyright 2002 Ralf S. Engelschall, Copyright 2002 e OSSP Project Copyright 2002 Cable & Wireless Deutschland. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em Este produto inclui software desenvolvido pela Boost ( ou sob a licença de software Boost. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em

3 Este produto inclui software copyright University of Cambridge. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em Este produto inclui o copyright de software 2007 The Eclipse Foundation. Todos os direitos reservados. As permissões e as limitações relativas a este software estão sujeitas aos termos disponíveis em e em Este produto inclui softwares licenciados de acordo com os termos disponíveis em License, license.html, asm.ow2.org/license.html, httpunit.sourceforge.net/doc/ license.html, license.html, license-agreement; /copyright-software ; forge.ow2.org/projects/javaservice/, license.html; protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; current/doc/mitk5license.html; blob/master/license; page=documents&file=license; blueprints/blob/master/license.txt; twbs/bootstrap/blob/master/license; Este produto inclui software licenciado de acordo com a Academic Free License ( a Common Development and Distribution License ( a Common Public License ( a Sun Binary Code License Agreement Supplemental License Terms, a BSD License ( a nova BSD License ( licenses/bsd-3-clause), a MIT License ( a Artistic License ( e a Initial Developer s Public License Version 1.0 ( Este produto inclui copyright do software Joe WaInes, XStream Committers. Todos os direitos reservados. Permissões e limitações relativas a este software estão sujeitas aos termos disponíveis em Este produto inclui software desenvolvido pelo Indiana University Extreme! Lab. Para obter mais informações, visite Este produto inclui software Copyright 2013 Frank Balluffi e Markus Moeller. Todos os direitos reservados. As permissões e limitações relativas a este software estão sujeitas aos termos da licença MIT. Consulte as patentes em ISENÇÃO DE RESPONSABILIDADE: a Informatica LLC fornece esta documentação no estado em que se encontra, sem garantia de qualquer tipo, expressa ou implícita, incluindo, mas não limitando-se, as garantias implícitas de não infração, comercialização ou uso para um determinado propósito. A Informatica LLC não garante que este software ou documentação não contenha erros. As informações fornecidas neste software ou documentação podem incluir imprecisões técnicas ou erros tipográficos. As informações deste software e documentação estão sujeitas a alterações a qualquer momento sem aviso prévio. AVISOS Este produto da Informatica (o "Software") traz determinados drivers (os "drivers da DataDirect") da DataDirect Technologies, uma empresa em funcionamento da Progress Software Corporation ("DataDirect"), que estão sujeitos aos seguintes termos e condições: 1. OS DRIVERS DA DATADIRECT SÃO FORNECIDOS NO ESTADO EM QUE SE ENCONTRAM, SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO LIMITANDO-SE, AS GARANTIAS IMPLÍCITAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UMA FINALIDADE ESPECÍFICA E NÃO INFRAÇÃO. 2. EM NENHUM CASO, A DATADIRECT OU SEUS FORNECEDORES TERCEIRIZADOS SERÃO RESPONSÁVEIS, EM RELAÇÃO AO CLIENTE FINAL, POR QUAISQUER DANOS DIRETOS, INDIRETOS, INCIDENTAIS, ESPECIAIS, CONSEQUENCIAIS OU DEMAIS QUE POSSAM ADVIR DO USO DE DRIVERS ODBC, SENDO OU NÃO ANTERIORMENTE INFORMADOS DAS POSSIBILIDADES DE TAIS DANOS. ESTAS LIMITAÇÕES SE APLICAM A TODAS AS CAUSAS DE AÇÃO, INCLUINDO, SEM LIMITAÇÕES, QUEBRA DE CONTRATO, QUEBRA DE GARANTIA, NEGLIGÊNCIA, RESPONSABILIDADE RIGOROSA, DETURPAÇÃO E OUTROS ATOS ILÍCITOS. Parte Número: MDM-CSG

4 Conteúdo Prefácio Recursos da Informatica Portal My Support da Informatica Documentação da Informatica Matrizes de Disponibilidade de Produto Informatica Site da Informatica Biblioteca de Recursos da Informatica Base de Dados de Conhecimento da Informatica Canal de Suporte da Informatica no YouTube Informatica Marketplace Informatica Velocity Suporte Global a Clientes da Informatica Capítulo 1: Introdução a Serviços de Entidade Comercial Visão Geral de Serviços de Entidade Comercial Serviços de Entidade Comercial Serviço de Entidade Comercial ReadBE Serviço de Entidade Comercial WriteBE Serviço de Entidade Comercial SearchBE Arquivos de Configuração de Serviço de Entidade Comercial Arquivo de Configuração de Serviço de Entidade Comercial Arquivo de Configuração de Serviço de Entidade Comercial REST Arquivo de Configuração de Serviço de Gravação de Entidade Comercial Arquivo de Configuração do Serviço de Pesquisa de Entidade Comercial Pontos de Extremidade de Serviços de Entidade Comercial Ponto de Extremidade Enterprise JavaBeans para Serviços de Entidade Comercial Ponto de Extremidade REST para Serviços de Entidade Comercial Chamadas de Serviços de Entidade Comercial REST e EJB Ponto de Extremidade SOAP para Serviços de Entidade Comercial Capítulo 2: Chamadas de Serviços de Entidade Comercial Enterprise Java Bean Visão Geral de Chamadas de Serviços de Entidade Comercial Enterprise Java Bean Exemplo de Código Java com Classes SDO padrão Exemplo de Código Java com Classes SDO Geradas Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer Visão Geral de APIs REST para Serviços de Entidade Comercial Métodos REST com Suporte Sumário

5 Método de Autenticação Cookies de Autenticação para Logon de Aplicativos de Terceiros Arquivo WADL (Web Application Description) Localizador de Recursos Uniforme REST Configuração do Cabeçalho e do Corpo Cabeçalho da Solicitação Corpo da Solicitação Parâmetros de Consulta Padrão Configurando o WebLogic para Executar Chamadas REST de Serviço de Entidade Comercial Visualizando Parâmetros de Entrada e Saída Modelo JavaScript Exemplo de JavaScript Referência de API REST para Serviços de Entidade Comercial Obter Metadados Ler Entidade Comercial Criar Entidade Comercial Atualizar Entidade Comercial Excluir Entidade Comercial Listar Entidade Comercial Pesquisar Entidade Comercial Agente de Sugestão Obter Metadados do BPM Listar Tarefas Ler Tarefa Criar Tarefa Atualizar Tarefa Tarefa Concluída Executar Ação de Tarefa Listar Usuários Atribuíveis Visualizar Promoção Promover Excluir Pendentes Visualizar Mesclagem Mesclar Registros Reverter a Mesclagem de Registros Obter Registos Relacionados Ler Registros Correspondidos Atualizar Registros Correspondidos Excluir Registros Correspondidos Capítulo 4: Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol Chamadas Simple Object Access Protocol para Serviços de Entidade Comercial Sumário 5

6 Método de autenticação Cookies de Autenticação para Logon de Aplicativos de Terceiros Arquivo WSDL (Web Services Description Language) URL SOAP Solicitações e Respostas SOAP Visualizando Parâmetros de Entrada e Saída Referência de API SOAP Solicitação e Resposta SOAP de Amostra Apêndice A: Usando APIs REST para Adicionar Registros de Entidade Comercial Usando APIs REST para Adicionar Registros de Entidade Comercial - Visão Geral Estrutura da Entidade Comercial Person Etapa 1. Obter Informações sobre o Esquema Obter Resposta de Metadados Etapa 2. Criar um Registro de Entidade Comercial Criar resposta de entidade comercial Etapa 3. Ler o Registro de Entidade Comercial Ler a Resposta do Registro de Entidade Comercial Índice Sumário

7 Prefácio Bem-vindo ao Guia de Serviços de Entidade Comercial do Informatica MDM Informatica MDM Multidomain Edition. Este guia explica como fazer chamadas de serviços de entidade comercial em entidades comerciais no MDM Hub. Seu público-alvo são especialistas técnicos responsáveis por configurar interfaces de usuário personalizadas para fazer chamadas de serviços de entidade comercial ao MDM Hub. Recursos da Informatica Portal My Support da Informatica Para o cliente da Informatica, o primeiro passo para nos contatar é acessar o Meu Portal de Suporte da Informatica em O Meu Portal de Suporte é a maior plataforma de colaboração de integração de dados online, com mais de clientes e parceiros da Informatica em todo o mundo. Como membro, você pode: Acessar todos os seus recursos Informatica em um só lugar. Revisar seus casos de suporte. Pesquisar a Base de Dados de Conhecimento, localizar documentação de produtos, acessar documentos de instruções e assistir vídeos de suporte. Encontrar a sua Rede de Grupo de Usuários da Informatica local e colaborar com seus colegas. Como membro, você pode: Acessar todos os seus recursos Informatica em um só lugar. Pesquisar a Base de Dados de Conhecimento, localizar documentação de produtos, acessar documentos de instruções e assistir vídeos de suporte. Encontrar a sua Rede de Grupo de Usuários da Informatica local e colaborar com seus colegas. Documentação da Informatica A equipe de Documentação da Informatica se esforça ao máximo para criar documentações precisas e utilizáveis. Se você tiver dúvidas, comentários ou ideias sobre esta documentação, entre em contato com a equipe de Documentação da Informatica pelo infa_documentation@informatica.com. Nós usaremos seu feedback para melhorar a documentação. Por favor, avise-nos se pudermos entrar em contato com você em relação aos comentários. 7

8 A equipe de Documentação atualiza a documentação conforme o necessário. Para obter a documentação mais recente do seu produto, navegue para Documentação do Produto no endereço Matrizes de Disponibilidade de Produto Informatica As Matrizes de Disponibilidade de Produto (PAMs) indicam as versões dos sistemas operacionais, os bancos de dados e outros tipos de fontes e destinos de dados com os quais uma versão de produto é compatível. Você pode acessar as PAMs no Portal do Meu Suporte da Informatica em Site da Informatica Você pode acessar o site corporativo da Informatica no endereçohttps:// O site contém informações sobre a Informatica, seu histórico, eventos futuros e escritórios de vendas. Você também vai encontrar informações sobre parceiros e produtos. A área de serviços do site inclui informações importantes sobre suporte técnico, treinamento e educação, bem como serviços de implementação. Biblioteca de Recursos da Informatica Na qualidade de cliente da Informatica, você pode acessar a Biblioteca de Recursos da Informatica no endereço A Biblioteca de Recursos é uma coletânea de recursos que o ajuda a aprender mais sobre os produtos e recursos da Informatica. Ela inclui artigos e demonstrações interativas que apresentam soluções a problemas comuns, comparam recursos e comportamentos e o orienta na execução de tarefas específicas no mundo real. Base de Dados de Conhecimento da Informatica Na qualidade de cliente da Informatica, você pode acessar a Base de Dados de Conhecimento da Informatica no endereço Use a Base de Dados de Conhecimento para pesquisar soluções documentadas a problemas técnicos conhecidos sobre produtos da Informatica. Você também pode encontrar respostas a perguntas frequentes, white papers e dicas técnicas. Se você tiver dúvidas, comentários ou ideias sobre a Base de Dados de Conhecimento, entre em contato com a equipe da Base de Dados de Conhecimento da Informatica pelo KB_Feedback@informatica.com. Canal de Suporte da Informatica no YouTube Você pode acessar o canal de Suporte da Informatica no YouTube O canal de Suporte da Informatica no YouTube inclui vídeos sobre soluções que orientam você na execução de tarefas específicas. Em caso de dúvidas, comentários ou ideias sobre o canal de Suporte da Informatica no YouTube, entre em contato com a equipe de Suporte do YouTube por em supportvideos@informatica.com ou envie um tweet Informatica Marketplace O Informatica Marketplace é um fórum em que desenvolvedores e parceiros podem compartilhar soluções para aumentar, ampliar ou aprimorar implementações da integração de dados. Ao tirar proveito de qualquer uma das centenas de soluções disponíveis no Marketplace, você pode melhorar sua produtividade e agilizar o tempo de implementação em seu projeto. Você pode acessar o Informatica Marketplace através do link 8 Prefácio

9 Informatica Velocity Você pode acessar o Informatica velocity em Desenvolvido com base na experiência no mundo real de centenas de projetos de gerenciamento de dados, o Informatica Velocity representa o conhecimento coletivo de nossos consultores, que trabalharam com organizações de todo o mundo para planejar, desenvolver, implantar e manter soluções de gerenciamento de dados bem-sucedidas. Se você tiver dúvidas, comentários ou ideias sobre o Informatica Velocity, entre em contato com os Serviços Profissionais da Informatica em ips@informatica.com. Suporte Global a Clientes da Informatica Você pode entrar em contato com o Centro de Suporte a Clientes por telefone ou pelo Suporte Online. O Suporte Online requer um nome de usuário e uma senha. Você pode solicitar um nome de usuário e uma senha no endereço Os números de telefone para o Suporte Global a Clientes da Informatica estão disponíveis no site da Informatica em Prefácio 9

10 C A P Í T U L O 1 Introdução a Serviços de Entidade Comercial Este capítulo inclui os seguintes tópicos: Visão Geral de Serviços de Entidade Comercial, 10 Serviços de Entidade Comercial, 11 Arquivos de Configuração de Serviço de Entidade Comercial, 12 Pontos de Extremidade de Serviços de Entidade Comercial, 16 Visão Geral de Serviços de Entidade Comercial Um serviço de entidade comercial é um conjunto de operações que executam um código do MDM Hub para criar, atualizar, excluir e procurar registros de objeto base em uma entidade comercial. É possível desenvolver uma interface de usuário personalizada capaz de executar código Java ou JavaScript para fazer chamadas de serviço de entidade comercial. Por exemplo, você pode criar um serviço de entidade comercial para aumentar um registro de fornecedor com dados da Dun and Bradstreet. Configure o serviço de entidade comercial para usar o registro de fornecedor como entrada, recuperar algumas informações da Dun and Bradstreet, atualizar o registo e então gerar o registro de fornecedor atualizado. Objetos base em uma entidade comercial têm os seguintes serviços de entidade comercial: Leitura Gravação Pesquisa Cada entidade comercial tem um serviço de entidade comercial para realizar uma operação de leitura. Cada entidade comercial tem um serviço de entidade comercial para realizar uma operação de gravação. Qualquer entidade comercial com campos pesquisáveis tem um serviço de entidade comercial para realizar uma operação de pesquisa. Por exemplo, uma entidade comercial Pessoa tem campos pesquisáveis. O MDM Hub gera um serviço de entidade comercial ReadPerson, WritePerson e SearchPerson. As etapas de serviços de entidade comercial de leitura, gravação e pesquisa permitem que você leia, crie, atualize, exclua e procure registros em uma entidade comercial. 10

11 Serviços de Entidade Comercial Um serviço de entidade comercial realiza uma operação. É possível usar os serviços de entidade comercial ReadBE, WriteBE e SearchBE. Um serviço de entidade comercial tem etapas de serviço. Uma solicitação de entrada passa por cada etapa de serviço. A saída de uma etapa é uma entrada para a próxima etapa. A saída de uma etapa pode passar informações para a entrada da etapa seguinte. Todas as etapas de serviço de entidade comercial são executadas como uma única chamada Enterprise Java Bean em uma única transação. O MDM Hub faz o tratamento de exceções. Nota: Antes de usar os serviços de entidade comercial, valide o Armazenamento de Referências Operacionais. Serviço de Entidade Comercial ReadBE O serviço de entidade comercial ReadBE lê dados de um registro de objeto base em uma entidade comercial. É possível especificar parâmetros de paginação com a etapa ReadBE para definir o número de registros a serem retornados e a página de resultados para exibição. Os resultados do serviço ReadBE não incluem registros com exclusão temporária. Se você não transmitir o parâmetro EffectiveDate na solicitação de serviço de entidade comercial, o MDM Hub assumirá um valor NULL para a data efetiva, e o serviço de entidade comercial fará a leitura dos dados no objeto base. Se você transmitir o parâmetro EffectiveDate, o MDM Hub calculará a melhor versão da verdade a partir dos registros de referência cruzada, e o serviço de leitura de entidade comercial retornará a melhor versão atualizada da verdade. Serviço de Entidade Comercial WriteBE O serviço de entidade comercial WriteBE pode atualizar os dados em um elemento de entidade comercial, criar um elemento de entidade comercial filho ou excluir elementos de entidade comercial filho. Períodos Efetivos Se você não transmitir o parâmetro EffectivePeriod, o MDM Hub assumirá um período ilimitado. O MDM Hub não verifica se há um alinhamento para períodos efetivos entre os objetos raiz e os objetos filho. Ao criar ou atualizar registros, verifique se os períodos efetivos do registro pai e dos registros filho estão alinhados. Confiança O serviço de entidade comercial WriteBE usa as configurações de confiança existentes para calcular a confiança nos objetos base. Não é possível realizar uma substituição de confiança com esse serviço. Serviço de Entidade Comercial SearchBE Use o serviço de entidade comercial SearchBE para procurar um registro raiz em uma entidade comercial. Para obter informações sobre como configurar entidades comerciais para a pesquisa inteligente, consulte o Guia de Configuração do Informatica MDM Multidomain Edition. Serviços de Entidade Comercial 11

12 Arquivos de Configuração de Serviço de Entidade Comercial Os arquivos de configuração de serviços de entidade comercial são arquivos XML gerados pela ferramenta de Provisionamento com base na configuração de entidades comerciais. Você pode usar a ferramenta de Provisionamento para gerar os arquivos de configuração de serviços de entidade comercial, fazer alterações e publicar essas alterações no MDM Hub. Quando você publica alterações, o Gerenciador de Repositório no Console do Hub valida a configuração. Para obter mais informações, consulte o Guia da Ferramenta de Provisionamento do Informatica MDM Multidomain Edition. O MDM Hub tem as seguintes configurações de serviço de entidade comercial: Configuração do Serviço de Entidade Comercial REST (Representational State Transfer) Define como URLs REST são mapeadas para chamadas de serviço de entidade comercial Enterprise Java Bean. Serviços de Entidade Comercial Configuração para todos os serviços de entidade comercial. O arquivo de configuração de serviços de entidade comercial contém as seguintes configurações de serviço de entidade comercial: configuração da etapa do serviço de entidade comercial para etapas de serviços de leitura, gravação, pesquisa e personalizados de entidade comercial. Configuração do serviço de leitura de entidade comerciall para cada objeto base em uma entidade comercial. Configuração do serviço de gravação de entidade comercial para cada objeto base em uma entidade comercial. Configuração do serviço de pesquisa de entidade comercial para cada objeto base em uma entidade comercial que tem pelo menos um campo pesquisável. Serviço de Gravação de Entidade Comercial Contém a configuração do serviço de gravação de entidade comercial. Serviço de Pesquisa de Entidade Comercial Contém a configuração do serviço de pesquisa de entidade comercial. Arquivo de Configuração de Serviço de Entidade Comercial O arquivo de configuração de serviço de entidade comercial define as três etapas do serviço de entidade comercial para ler, gravar e pesquisar registros de objeto base. O arquivo de configuração de serviço de entidade comercial também define os parâmetros de serviço de entidade comercial para cada objeto base da entidade comercial. Se você adicionar objetos de entidade comercial manualmente à configuração da entidade comercial, também deverá adicionar os serviços de entidade comercial relacionados. O seguinte código mostra a configuração do serviço de leitura de entidade comercial para o objeto raiz Organization: <service name="readorganization"> <parameter type="cofilter" uri="urn:cs-base.informatica.mdm" required="true" directionkind="in" name="cofilter"/> <parameter type="date" uri="commonj.sdo" required="false" directionkind="in" name="effectivedate"/> <parameter type="boolean" uri="commonj.sdo" required="false" directionkind="in" name="readsystemfields"/> 12 Capítulo 1: Introdução a Serviços de Entidade Comercial

13 <output type="organization" uri="urn:co-ors.informatica.mdm"/> <execution> <execute name="s1" target="readco" type="service"/> </execution> </service> O seguinte código mostra a configuração do serviço de gravação de entidade comercial para o objeto raiz Organization: <service name="writeorganization"> <parameter type="string" uri="commonj.sdo" required="true" directionkind="in" name="systemname"/> <parameter type="string" uri="commonj.sdo" required="false" directionkind="in_out" name="interactionid"/> <parameter type="effectiveperiod" uri="urn:cs-base.informatica.mdm" required="false" directionkind="in" name="effectiveperiod"/> <input type="organization" uri="urn:co-ors.informatica.mdm"/> <output type="organization" uri="urn:co-ors.informatica.mdm"/> <execution> <execute name="s1" target="writeco" type="service"/> </execution> </service> O seguinte código mostra a configuração do serviço de pesquisa de entidade comercial para o objeto raiz Organization: <service name="searchorganization"> <parameter type="string" uri="commonj.sdo" required="true" directionkind="in" name="query"/> <parameter type="cofilter" uri="urn:cs-base.informatica.mdm" required="false" directionkind="in" name="cofilter"/> <parameter type="pager" uri="urn:cs-base.informatica.mdm" required="false" directionkind="in" name="pager"/> <output type="organization.pager" uri="urn:co-ors.informatica.mdm"/> <execution> <execute name="s1" target="searchco" type="service"> <parameter name="coname"> <stringvalue>organization</stringvalue> </parameter> </execute> </execution> </service> Arquivo de Configuração de Serviço de Entidade Comercial REST O MDM Hub gera a configuração de serviço de entidade comercial REST (Representational State Transfer) com base na configuração de entidade comercial gerada pelo Gerenciador de Configuração do Informatica Data Director. Se você adicionar entidades comerciais manualmente à configuração e quiser fazer chamadas REST, deverá configurar manualmente os respectivos serviços de entidade comercial REST. A seguinte amostra de código exibe a configuração REST do serviço de leitura de entidade comercial para a entidade comercial Person: <request name="readperson"> <pattern> <httpmethod>get</httpmethod> <path> <co identities="optional">/person/(.+)</co> <static>(\.json \.xml)?</static> </path> </pattern> <invoke service="readperson"> <parameter name="cofilter" parser="cofilterfromurl"/> <parameter name="effectivedate" queryparam="effectivedate"/> <parameter name="readsystemfields" queryparam="readsystemfields"/> </invoke> <output> <process processor="extractresponseobject"/> Arquivos de Configuração de Serviço de Entidade Comercial 13

14 <process processor="addpagerlinks"/> <process processor="addchildrenlinks"/> <process processor="addparentlink"/> <process processor="addselflink"/> <process processor="compactresult"/> <write writer="sdotobody"/> </output> </request> A seguinte amostra de código exibe a configuração REST do serviço de gravação de entidade comercial para a entidade comercial Person: <request name="writeperson"> <pattern> <httpmethod>put</httpmethod> <httpmethod>post</httpmethod> <httpmethod>delete</httpmethod> <path> <co identities="optional">/person(/.*)?</co> <static>(\.json \.xml)?</static> </path> </pattern> <invoke service="writeperson"> <input parser="cosdofromurlandbody"/> <parameter name="systemname" queryparam="systemname"/> <parameter name="interactionid" queryparam="interactionid"/> <parameter name="effectiveperiod" parser="effectiveperiodfromurl"/> </invoke> <output> <process processor="extractresponseobject"/> <write writer="sdotobody"/> </output> A seguinte amostra de código exibe a configuração REST do serviço de pesquisa de entidade comercial para a entidade comercial Person: <request name="searchperson"> <pattern> <httpmethod>get</httpmethod> <path> <co identities="prohibited">/person</co> <static>(\.json \.xml)?</static> </path> </pattern> <invoke service="searchperson"> <parameter name="query" queryparam="q"/> <parameter name="pager" parser="pagerfromurl"/> </invoke> <output> <process processor="extractresponseobject"/> <process processor="addcopagerlinks"/> <process processor="addchildrenlinks"/> <process processor="addparentlink"/> <process processor="addselflink"/> <write writer="sdotobody"/> </output> </request> Arquivo de Configuração de Serviço de Gravação de Entidade Comercial O arquivo de configuração de serviço de gravação de entidade comercial contém configurações que determinam como o MDM Hub cria, atualiza e exclui registros de objetos base filho. É possível configurar os seguintes parâmetros de etapas WriteBE: 14 Capítulo 1: Introdução a Serviços de Entidade Comercial

15 identifyingstrategy Determina como o MDM Hub verifica a existência de um registro filho. Quando você adiciona um registro filho a uma entidade comercial, o MDM Hub determina se esse registro é novo ou já existe. É possível configurar os seguintes atributos identifyingstrategy: onerow norow Determina o comportamento quando um registro existe. O atributo onerow pode ter os seguintes valores: ACCEPT CREATE ERROR O MDM Hub não cria um registro filho. O padrão é ACCEPT. O MDM Hub cria um registro filho. O MDM Hub não cria um registro filho. Ocorre um erro. Determina o comportamento quando um registro não existe. O atributo norow pode ter os seguintes valores: CREATE ERROR O MDM Hub cria um registro filho. O MDM Hub não cria um registro filho. Ocorre um erro. identifyingstrategy pode ter os seguintes elementos aninhados: byrowid Identifica os registros existentes pelo valor de ROWID_OBJECT. A estratégia byrowid é implícita e é sempre usada. bypksourcesystem Identifica registros existente por chave primária e sistema de origem. A estratégia bypksourcesystem é implícita e é sempre usada. byuniquecolumn Identifica registros existentes pelo valor na coluna exclusiva. deletestrategy Determina o comportamento quando você exclui um registro filho. O atributo type de deletestrategy pode ter os seguintes valores: DISASSOCIATE Os registros permanecem ativos, mas a chave externa é definida como nula. O padrão é DISASSOCIATE. SOFT_DELETE Exclui o registro temporariamente. O MDM Hub define HUB_STATE_IND como -1. DELETE_PARENT Exclui o registro da tabela de relacionamentos. O registro filho não é excluído. Arquivos de Configuração de Serviço de Entidade Comercial 15

16 Arquivo de Configuração do Serviço de Pesquisa de Entidade Comercial A configuração do serviço de pesquisa de entidade comercial indica quais campos de objeto base são pesquisáveis. A configuração de serviços de pesquisa de entidade comercial é necessária para a Pesquisa Inteligente. Para obter informações sobre como configurar a pesquisa inteligente, consulte o Guia de Configuração do Informatica MDM Multidomain Edition. Pontos de Extremidade de Serviços de Entidade Comercial É possível acessar serviços de entidade comercial por meio de um ponto de extremidade EJB (Enterprise JavaBeans), REST (Representational State Transfer) ou SOAP (Simple Object Access Protocol). Pontos de extremidade REST são criados com base em um ponto de vista EJB. A configuração do serviço de entidade comercial REST define como as URLs REST são mapeadas para as chamadas de serviço de entidade comercial EJB. Ponto de Extremidade Enterprise JavaBeans para Serviços de Entidade Comercial O ponto de extremidade Enterprise JavaBeans (EJB) é o ponto de extremidade subjacente para todos os tipos de chamadas de serviços de entidade comercial. Todos os outros pontos de extremidade são mapeados para o ponto de extremidade EJB Serviços de entidade comercial são expostos como um EJB sem monitoramento de estado. Um contêiner EJB sem monitoramento de estado pode definir pools de instâncias, alocar instâncias e aplicar estratégias de balanceamento de carga para distribuir a carga entre diferentes servidores no domínio. Um ponto de extremidade EJB aceita um nome de usuário e uma senha para autenticação. Ponto de Extremidade REST para Serviços de Entidade Comercial Chamadas de ponto de extremidade REST (Representational State Transfer) disponibilizam serviços de entidade comercial como serviços da Web. Arquivos WADL (Web Application Description Language) contêm descrições XML dos serviços da Web REST, todos os URLs REST e todos os parâmetros REST. O MDM Hub gera um arquivo WADL para cada Armazenamento de Referências Operacionais. É possível baixar os arquivos WADL para cada Armazenamento de Referências Operacionais na seguinte localização: 16 Capítulo 1: Introdução a Serviços de Entidade Comercial

17 Chamadas de Serviços de Entidade Comercial REST e EJB Ao fazer uma chamada de serviço de entidade comercial, você pode especificar determinadas ramificações filho em vez de solicitar a entidade comercial inteira. Por exemplo, você deseja realizar uma operação de leitura em uma entidade comercial que tem um nó raiz Pessoa e várias ramificações filho. O objeto base Pessoa tem os objetos base filho Endereço, Telefone, E- mail. Cada objeto base filho tem dois objetos base neto. A seguinte imagem mostra a estrutura de uma entidade comercial com várias ramificações: É possível ler a partir de várias ramificações filho em várias profundidades em uma única solicitação. Por exemplo, você pode ler Pessoa, Telefone, Detalhes do Telefone 1, Detalhes do Telefone 2, e Detalhes do 2 em uma única solicitação. A seguinte amostra de URL indica como fazer uma solicitação de leitura REST para obter o registro de Pessoa com o ID de linha 1242, além dos registros filho de Detalhes do Endereço 1 e Address_Details_1, Ponto de Extremidade SOAP para Serviços de Entidade Comercial Chamadas de ponto de extremidade SOAP (Simple Object Access Protocol) disponibilizam serviços de entidade comercial como serviços da Web. Arquivos WSDL (Web Services Description Language) contêm as descrições XML dos serviços da Web, os formatos das solicitações e respostas SOAP e todos os parâmetros. O MDM Hub gera um arquivo WSDL para cada Armazenamento de Referências Operacionais. Pontos de Extremidade de Serviços de Entidade Comercial 17

18 C A P Í T U L O 2 Chamadas de Serviços de Entidade Comercial Enterprise Java Bean Este capítulo inclui os seguintes tópicos: Visão Geral de Chamadas de Serviços de Entidade Comercial Enterprise Java Bean, 18 Exemplo de Código Java com Classes SDO padrão, 18 Exemplo de Código Java com Classes SDO Geradas, 22 Visão Geral de Chamadas de Serviços de Entidade Comercial Enterprise Java Bean É possível fazer chamadas de serviços de entidade comercial EJB (Enterprise Java Bean) para criar, atualizar, excluir e procurar registros de objeto base em uma entidade comercial. Você pode criar um código Java para executar chamadas de serviços de entidade comercial EJB. Você pode criar um código Java com base em classes SDO (Service Data Objects) padrão ou pode criar um código Java com base em classes Java geradas pelo MDM Hub de acordo com a configuração de entidades comercias e de serviços de entidade comercial. Exemplo de Código Java com Classes SDO padrão O exemplo mostra o código Java para executar chamadas EJB (Enterprise Java Bean) com base em classes SDO (Service Data Objects) padrão. O exemplo está no seguinte arquivo do kit de recursos: C:\<diretório de instalação infamdm>\hub \resourcekit\samples\cos\source\java\com\informatica\mdm\sample\cs\dynamicsdo.java 18

19 O seguinte código Java se baseia em classes SDO padrão e executa chamadas de serviços de entidade comercial EJB para criar um registro de objeto base Person, adicionar vários registros filho, excluir um registro filho e depois excluir o registro Person e todos os registros filho: package com.informatica.mdm.sample.cs; import com.informatica.mdm.cs.callcontext; import com.informatica.mdm.cs.api.compositeserviceexception; import com.informatica.mdm.cs.client.compositeserviceclient; import com.siperian.sif.client.ejbsiperianclient; import com.siperian.sif.client.siperianclient; import commonj.sdo.dataobject; import commonj.sdo.property; import commonj.sdo.type; import commonj.sdo.helper.datafactory; import commonj.sdo.helper.helpercontext; import java.io.printstream; import java.util.arrays; import java.util.properties; public class DynamicSDO public static void main(string[] args) throws CompositeServiceException if(args.length!= 3) System.err.println("USAGE: DynamicSDO <ors> <user> <pass>"); return; new DynamicSDO(args[0], args[1], args[2]).execute(); private String orsid; private String user; private String pass; private HelperContext helpercontext; private PrintStream out = System.out; public DynamicSDO(String orsid, String user, String pass) this.orsid = orsid; this.user = user; this.pass = pass; public void execute() throws CompositeServiceException String systemname = "Admin"; Properties config = new Properties(); config.put(siperianclient.siperianclient_protocol, EjbSiperianClient.PROTOCOL_NAME); CompositeServiceClient client = CompositeServiceClient.newCompositeServiceClient(config); CallContext callcontext = new CallContext(orsId, user, pass); helpercontext = client.gethelpercontext(callcontext); DataFactory datafactory = helpercontext.getdatafactory(); // types for Read requests Type cofiltertype = helpercontext.gettypehelper().gettype("urn:csbase.informatica.mdm", "CoFilter"); Type cofilternodetype = helpercontext.gettypehelper().gettype("urn:csbase.informatica.mdm", "CoFilterNode"); Type keytype = helpercontext.gettypehelper().gettype("urn:csbase.informatica.mdm", "Key"); // ReadCO & WriteCO request types Exemplo de Código Java com Classes SDO padrão 19

20 Type readpersontype = helpercontext.gettypehelper().gettype("urn:csors.informatica.mdm", "ReadPerson"); Type writepersontype = helpercontext.gettypehelper().gettype("urn:csors.informatica.mdm", "WritePerson"); // 1. Create new person DataObject createperson = datafactory.create(writepersontype); DataObject createpersonparameters = createperson.createdataobject("parameters"); createpersonparameters.setstring("systemname", systemname); DataObject person = createperson.createdataobject("object"); person.getchangesummary().beginlogging(); DataObject personroot = person.createdataobject("person"); personroot.setstring("firstname", "John"); personroot.setstring("lastname", "Smith"); person.getchangesummary().endlogging(); dump("*** CREATE NEW PERSON...", createperson); DataObject createpersonresponse = client.process(callcontext, createperson); dump("*** PERSON CREATED:", createpersonresponse); String personrowid = createpersonresponse.getstring("object/person/ rowidobject"); DataObject readperson = datafactory.create(readpersontype); DataObject readpersonparameters = readperson.createdataobject("parameters"); DataObject cofilter = readpersonparameters.createdataobject("cofilter"); DataObject cofilternode = cofilter.createdataobject("object"); cofilternode.set("name", "Person"); DataObject key = cofilternode.createdataobject("key"); key.set("rowid", personrowid); dump("*** READ CREATED PERSON...", readperson); DataObject readpersonresponse = client.process(callcontext, readperson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getdataobject("object"); person.detach(); person.getchangesummary().beginlogging(); personroot = person.getdataobject("person"); // add new 'one' child DataObject gendercd = personroot.createdataobject("gendercd"); gendercd.setstring("gendercode", "M"); // add two 'many' children DataObject phonepager = personroot.createdataobject("telephonenumbers"); Property item = phonepager.getinstanceproperty("item"); Type phonetype = item.gettype(); DataObject phone1 = datafactory.create(phonetype); phone1.setstring("phonenumber", " "); DataObject phone2 = datafactory.create(phonetype); phone2.setstring("phonenumber", " "); phonepager.setlist(item, Arrays.asList(phone1, phone2)); person.getchangesummary().endlogging(); DataObject updateperson = datafactory.create(writepersontype); updateperson.setdataobject("object", person); DataObject updatepersonparameters = updateperson.createdataobject("parameters"); updatepersonparameters.setstring("systemname", systemname); updatepersonparameters.setstring("interactionid", ""); 20 Capítulo 2: Chamadas de Serviços de Entidade Comercial Enterprise Java Bean

21 dump("*** UPDATE PERSON...", updateperson); DataObject updatepersonresponse = client.process(callcontext, updateperson); dump("*** PERSON UPDATED:", updatepersonresponse); cofilternode.set("depth", 3); readpersonparameters.setboolean("readsystemfields", true); dump("*** READ UPDATED PERSON WITH CHILDREN...", readperson); readpersonresponse = client.process(callcontext, readperson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getdataobject("object"); person.detach(); person.getchangesummary().beginlogging(); gendercd = person.getdataobject("person").createdataobject("gendercd"); gendercd.setstring("gendercode", "F"); // delete one phone DataObject phoneitem = person.getdataobject("person/telephonenumbers/item[1]"); phoneitem.delete(); person.getchangesummary().endlogging(); DataObject deletephone = datafactory.create(writepersontype); deletephone.setdataobject("object", person); DataObject deletephoneparameters = deletephone.createdataobject("parameters"); deletephoneparameters.setstring("systemname", systemname); dump("*** DELETE CHILD...", deletephone); DataObject deletephoneresponse = client.process(callcontext, deletephone); dump("*** CHILD DELETED:", deletephoneresponse); readpersonparameters.setboolean("readsystemfields", false); dump("*** READ PERSON AFTER CHILD WAS DELETEED...", readperson); readpersonresponse = client.process(callcontext, readperson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getdataobject("object"); person.detach(); person.getchangesummary().beginlogging(); person.getdataobject("person").detach(); person.getchangesummary().endlogging(); DataObject deleteperson = datafactory.create(writepersontype); deleteperson.setdataobject("object", person); DataObject deletepersonparameters = deleteperson.createdataobject("parameters"); deletepersonparameters.setstring("systemname", systemname); dump("*** DELETE PERSON...", deleteperson); DataObject deletepersonresponse = client.process(callcontext, deleteperson); dump("*** PERSON DELETED:", deletepersonresponse); dump("*** TRY TO READ PERSON AFTER DELETE", readperson); Exemplo de Código Java com Classes SDO padrão 21

22 try readpersonresponse = client.process(callcontext, readperson); dump("*** READ RESULT:", readpersonresponse); catch (CompositeServiceException e) out.println("*** READ RESULT: " + e.getlocalizedmessage()); private void dump(string title, DataObject dataobject) String xml = helpercontext.getxmlhelper().save( dataobject, dataobject.gettype().geturi(), dataobject.gettype().getname()); out.println(title); out.println(xml); out.println(); Exemplo de Código Java com Classes SDO Geradas O exemplo mostra o código Java para executar chamadas EJB (Enterprise Java Bean) com base em classes Java geradas pelo MDM Hub de acordo com a configuração de entidades comercias e de serviços de entidade comercial. O exemplo está no seguinte arquivo do kit de recursos: C:\<diretório de instalação infamdm>\hub \resourcekit\samples\cos\source\java\com\informatica\mdm\sample\cs\generatedsdo.java O seguinte código Java se baseia em classes geradas e executa chamadas de serviços de entidade comercial EJB para criar um registro de objeto base Person, adicionar vários registros filho, excluir um registro filho e depois excluir o registro Person e todos os registros filho: package com.informatica.mdm.sample.cs; import com.informatica.mdm.cs.callcontext; import com.informatica.mdm.cs.api.compositeserviceexception; import com.informatica.mdm.cs.client.compositeserviceclient; import com.informatica.mdm.sdo.cs.base.cofilter; import com.informatica.mdm.sdo.cs.base.cofilternode; import com.informatica.mdm.sdo.cs.base.key; import com.siperian.sif.client.ejbsiperianclient; import com.siperian.sif.client.siperianclient; import commonj.sdo.dataobject; import commonj.sdo.helper.datafactory; import commonj.sdo.helper.helpercontext; import mdm.informatica.co_ors.*; import mdm.informatica.cs_ors.*; import java.io.printstream; import java.util.arrays; import java.util.properties; public class GeneratedSDO public static void main(string[] args) throws CompositeServiceException if(args.length!= 3) System.err.println("USAGE: GeneratedSDO <ors> <user> <pass>"); return; 22 Capítulo 2: Chamadas de Serviços de Entidade Comercial Enterprise Java Bean

23 new GeneratedSDO(args[0], args[1], args[2]).execute(); private String orsid; private String user; private String pass; private HelperContext helpercontext; private PrintStream out = System.out; public GeneratedSDO(String orsid, String user, String pass) this.orsid = orsid; this.user = user; this.pass = pass; public void execute() throws CompositeServiceException String systemname = "Admin"; Properties config = new Properties(); config.put(siperianclient.siperianclient_protocol, EjbSiperianClient.PROTOCOL_NAME); CompositeServiceClient client = CompositeServiceClient.newCompositeServiceClient(config); CallContext callcontext = new CallContext(orsId, user, pass); helpercontext = client.gethelpercontext(callcontext); DataFactory datafactory = helpercontext.getdatafactory(); // 1. Create new person WritePerson createperson = (WritePerson)dataFactory.create(WritePerson.class); WritePersonParameters createpersonparameters = (WritePersonParameters)dataFactory.create(WritePersonParameters.class); createpersonparameters.setsystemname(systemname); createperson.setparameters(createpersonparameters); Person person = (Person)dataFactory.create(Person.class); createperson.setobject(person); person.getchangesummary().beginlogging(); PersonRoot personroot = (PersonRoot)dataFactory.create(PersonRoot.class); personroot.setfirstname("john"); personroot.setlastname("smith"); person.setperson(personroot); person.getchangesummary().endlogging(); dump("*** CREATE NEW PERSON...", createperson); WritePersonReturn createpersonresponse = (WritePersonReturn)client.process(callContext, (DataObject)createPerson); dump("*** PERSON CREATED:", createpersonresponse); String personrowid = createpersonresponse.getobject().getperson().getrowidobject(); Key key = (Key)dataFactory.create(Key.class); key.setrowid(personrowid); CoFilterNode cofilternode = (CoFilterNode)dataFactory.create(CoFilterNode.class); cofilternode.setname(person.class.getsimplename()); cofilternode.setkey(key); CoFilter cofilter = (CoFilter)dataFactory.create(CoFilter.class); cofilter.setobject(cofilternode); Exemplo de Código Java com Classes SDO Geradas 23

24 ReadPersonParameters readpersonparameters = (ReadPersonParameters)dataFactory.create(ReadPersonParameters.class); readpersonparameters.setcofilter(cofilter); ReadPerson readperson = (ReadPerson)dataFactory.create(ReadPerson.class); readperson.setparameters(readpersonparameters); dump("*** READ CREATED PERSON...", readperson); ReadPersonReturn readpersonresponse = (ReadPersonReturn)client.process(callContext, (DataObject)readPerson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getobject(); ((DataObject)person).detach(); person.getchangesummary().beginlogging(); personroot = person.getperson(); // add new 'one' child LUGenderLookup gendercd = (LUGenderLookup)dataFactory.create(LUGenderLookup.class); gendercd.setgendercode("m"); personroot.setgendercd(gendercd); // add two 'many' children PersonTelephoneNumbersPager phonepager = (PersonTelephoneNumbersPager)dataFactory.create(PersonTelephoneNumbersPager.class); PersonTelephoneNumbers phone1 = (PersonTelephoneNumbers)dataFactory.create(PersonTelephoneNumbers.class); phone1.setphonenumber(" "); PersonTelephoneNumbers phone2 = (PersonTelephoneNumbers)dataFactory.create(PersonTelephoneNumbers.class); phone2.setphonenumber(" "); phonepager.setitem(arrays.aslist(phone1, phone2)); personroot.settelephonenumbers(phonepager); person.getchangesummary().endlogging(); WritePerson updateperson = (WritePerson)dataFactory.create(WritePerson.class); updateperson.setobject(person); WritePersonParameters updatepersonparameters = (WritePersonParameters)dataFactory.create(WritePersonParameters.class); updatepersonparameters.setsystemname(systemname); updatepersonparameters.setinteractionid(""); updateperson.setparameters(updatepersonparameters); dump("*** UPDATE PERSON...", updateperson); WritePersonReturn updatepersonresponse = (WritePersonReturn)client.process(callContext, (DataObject)updatePerson); dump("*** PERSON UPDATED:", updatepersonresponse); cofilternode.setdepth(3); readpersonparameters.setreadsystemfields(true); dump("*** READ UPDATED PERSON WITH CHILDREN (with system fields)...", readperson); readpersonresponse = (ReadPersonReturn)client.process(callContext, (DataObject)readPerson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getobject(); ((DataObject)person).detach(); 24 Capítulo 2: Chamadas de Serviços de Entidade Comercial Enterprise Java Bean

25 person.getchangesummary().beginlogging(); // delete one phone person.getperson().gettelephonenumbers().getitem().remove(0); // change gender gendercd = (LUGenderLookup)dataFactory.create(LUGenderLookup.class); gendercd.setgendercode("f"); personroot.setgendercd(gendercd); person.getchangesummary().endlogging(); WritePerson deletephone = (WritePerson)dataFactory.create(WritePerson.class); deletephone.setobject(person); WritePersonParameters deletephoneparameters = (WritePersonParameters)dataFactory.create(WritePersonParameters.class); deletephoneparameters.setsystemname(systemname); deletephone.setparameters(deletephoneparameters); dump("*** DELETE CHILD...", deletephone); WritePersonReturn deletephoneresponse = (WritePersonReturn)client.process(callContext, (DataObject)deletePhone); dump("*** CHILD DELETED:", deletephoneresponse); readpersonparameters.setreadsystemfields(false); dump("*** READ PERSON AFTER CHILD WAS DELETEED...", readperson); readpersonresponse = (ReadPersonReturn)client.process(callContext, (DataObject)readPerson); dump("*** READ RESULT:", readpersonresponse); person = readpersonresponse.getobject(); ((DataObject)person).detach(); person.getchangesummary().beginlogging(); ((DataObject)person.getPerson()).delete(); person.getchangesummary().endlogging(); WritePerson deleteperson = (WritePerson)dataFactory.create(WritePerson.class); deleteperson.setobject(person); WritePersonParameters deletepersonparameters = (WritePersonParameters)dataFactory.create(WritePersonParameters.class); deletepersonparameters.setsystemname(systemname); deleteperson.setparameters(deletepersonparameters); dump("*** DELETE PERSON...", deleteperson); WritePersonReturn deletepersonresponse = (WritePersonReturn)client.process(callContext, (DataObject)deletePerson); dump("*** PERSON DELETED:", deletepersonresponse); dump("*** TRY TO READ PERSON AFTER DELETE", readperson); try readpersonresponse = (ReadPersonReturn)client.process(callContext, (DataObject)readPerson); dump("*** READ RESULT:", readpersonresponse); catch (CompositeServiceException e) out.println("*** READ RESULT: " + e.getlocalizedmessage()); Exemplo de Código Java com Classes SDO Geradas 25

26 private void dump(string title, Object object) DataObject dataobject = (DataObject)object; String xml = helpercontext.getxmlhelper().save( dataobject, dataobject.gettype().geturi(), dataobject.gettype().getname()); out.println(title); out.println(xml); out.println(); 26 Capítulo 2: Chamadas de Serviços de Entidade Comercial Enterprise Java Bean

27 C A P Í T U L O 3 Chamadas de Serviços de Entidade Comercial Representational State Transfer Este capítulo inclui os seguintes tópicos: Visão Geral de APIs REST para Serviços de Entidade Comercial, 27 Métodos REST com Suporte, 28 Método de Autenticação, 28 Cookies de Autenticação para Logon de Aplicativos de Terceiros, 28 Arquivo WADL (Web Application Description), 29 Localizador de Recursos Uniforme REST, 30 Configuração do Cabeçalho e do Corpo, 31 Parâmetros de Consulta Padrão, 33 Configurando o WebLogic para Executar Chamadas REST de Serviço de Entidade Comercial, 34 Visualizando Parâmetros de Entrada e Saída, 35 Modelo JavaScript, 35 Exemplo de JavaScript, 36 Referência de API REST para Serviços de Entidade Comercial, 38 Visão Geral de APIs REST para Serviços de Entidade Comercial Chamadas de ponto de extremidade REST disponibilizam todos os serviços de entidade comercial como serviços da Web. É possível fazer chamadas REST para criar, atualizar, excluir e procurar registros de objeto base e registros filho relacionados em uma entidade comercial. Você pode realizar operações, como mesclar, cancelar mesclagens e corresponder registros. Também pode fazer chamadas REST para criar, atualizar, procurar e realizar tarefas. Uma chamada de serviço de entidade comercial REST é uma solicitação de serviço da Web no formato de URL (Localizador de Recursos Uniforme). O MDM Hub atribui uma URL exclusiva para cada objeto base em 27

28 uma entidade comercial. É possível usar a URL exclusiva para identificar qual objeto base deve ser atualizado ou excluído. Nota: Antes de usar as APIS REST para chamar os serviços de entidade comercial, valide o Armazenamento de Referências Operacionais. Métodos REST com Suporte As APIs REST para serviços de entidade comercial usam os métodos HTTP padrão para realizar operações nos recursos, como entidades comerciais e tarefas. As APIs REST para serviços de entidade comercial oferecem suporte aos seguintes métodos de solicitação HTTP: Método GET POST PUT PATCH DELETE Descrição Recupera informações sobre uma entidade comercial ou uma tarefa. Cria uma tarefa, um registro raiz de entidade comercial ou um registro filho de entidade comercial. Atualiza uma tarefa, um registro raiz de entidade comercial ou um registro filho de entidade comercial. Atualiza uma tarefa parcialmente. Atualiza um registro raiz de entidade comercial ou um registro filho de entidade comercial. Método de Autenticação Os pontos de extremidade REST para serviços de entidade comercial usam o método de autenticação HTTP básico para autenticar usuários. Quando você se conecta primeiro a um serviço de entidade comercial usando o navegador, deve fornecer seu nome de usuário e sua senha do MDM Hub. Após a autenticação bem-sucedida, é possível usar as APIs REST de serviços de entidade comercial para realizar operações. O navegador armazena as credenciais do usuário em cache e as usa com cada solicitação subsequente para um serviço de entidade comercial. Cookies de Autenticação para Logon de Aplicativos de Terceiros Use cookies de autenticação para autenticar os usuários do MDM Hub e chamar os serviços de entidade comercial de aplicativos de terceiros. É possível obter um cookie com base nas credenciais de um usuário 28 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

29 autenticado. Salve o cookie e use-o para chamar as APIs REST. Não é necessário inserir o nome de usuário e a senha em código fixo. Realize a seguinte solicitação POST para fazer logon na Exibição do Entity 360 com seu nome de usuário e sua senha: POST user: 'admin', password: 'user password' Quando a operação de logon for bem-sucedida, o servidor retornará o cookie de autenticação no campo de cabeçalho set-cookie. O seguinte código de amostra apresenta um set-cookie no cabeçalho de resposta: Set-Cookie: auth_hash_cookie="admin===qtc1rkngqkncmzc1rjiyoq=="; Version=1; Path=/ Armazene o hash e use-o no cabeçalho de solicitação das suas chamadas de API. Não é necessário fornecer um nome de usuário e uma senha para as chamadas de API. O seguinte exemplo mostra como usar um cookie de autenticação no seu cabeçalho de solicitação de API: GET of host>:8080/cmx/cs/localhost-orcl-ds_ui1/person?action=meta Cookie: auth_hash_cookie="admin===qtc1rkngqkncmzc1rjiyoq==" Arquivo WADL (Web Application Description) Arquivos WADL (Web Application Description Language) contêm descrições XML dos serviços da Web REST, todos os URLs REST e todos os parâmetros REST. O MDM Hub gera um arquivo WADL para cada Armazenamento de Referências Operacionais. Os arquivos WADL para cada Armazenamento de Referências Operacionais estão na seguinte localização: Arquivo WADL (Web Application Description) 29

30 A seguinte imagem mostra a localização onde você pode baixar o arquivo WADL para os Armazenamentos de Referências Operacionais: 1. Link para baixar o arquivo WADL para o Armazenamento de Referências Operacionais SUPPLIER_HUB_COCS 2. Link para baixar o arquivo WADL para o Armazenamento de Referências Operacionais DS_UI1 Localizador de Recursos Uniforme REST Use uma URL REST para fazer chamadas REST para serviços de entidade comercial. A URL REST tem a seguinte sintaxe: ID>/<path> A URL tem os seguintes campos: host porta contexto O host que está executando o banco de dados. Número de porta usado pelo ouvinte do banco de dados. O contexto é sempre cmx/cs. 30 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

31 ID do banco de dados caminho O ID do ORS registrado na ferramenta Bancos de Dados do Console do Hub. Se a URL for para um registro raiz, o caminho será o nome do objeto raiz seguido por um identificador exclusivo. Um exemplo de caminho para um registro raiz de Pessoa é Pessoa/ json. Se a URL for para um registro que é um filho direto do objeto raiz, o caminho também incluirá o nome do registro filho e um identificador exclusivo. Um exemplo de caminho para um registro de endereço de faturamento que é um filho de um registro raiz de Pessoa é: Pessoa/798243/BillAddresses/ json. Se a URL for para um registo filho que está a uma profundidade de dois ou mais, o caminho também incluirá essa profundidade. O seguinte URL é um exemplo de um URL REST para um registro filho com uma profundidade de 2: depth=2 Nota: Os parâmetros fazem distinção entre maiúsculas e minúsculas. Verifique se a formatação de maiúsculas e minúsculas na URL REST corresponde à formatação de maiúsculas e minúsculas dos nomes de parâmetros na configuração REST. Configuração do Cabeçalho e do Corpo Uma operação REST combina um método HTTP com a URL completa para o recurso. Para uma solicitação completa, combine a operação REST com os cabeçalhos HTTP apropriados e quaisquer dados necessários. Uma solicitação REST tem um cabeçalho e um componente de corpo. Você pode usar o JSON ou o formato XML para definir uma solicitação. Cabeçalho da Solicitação Use um cabeçalho de solicitação para definir os parâmetros operacionais ou os metadados da operação REST. O cabeçalho é formado por uma série de pares de campo/valor. A linha de solicitação da API contém o método e a URL. Especifique os campos de cabeçalho após a linha da solicitação. Para construir o cabeçalho de solicitação da API REST, adicione os campos de cabeçalho após a linha de solicitação <METHOD> <<host>:<port>/<context>/<database ID>/<Path>, como mostra o exemplo a seguir: <METHOD> <<host>:<port>/<context>/<database ID>/<Path> Content-Type: application/<json/xml> Accept: application/<json/xml> Configuração do Cabeçalho e do Corpo 31

32 A seguinte tabela descreve alguns dos campos de cabeçalho de solicitação comumente utilizados: Componente da solicitação Content-Type Accept Descrição Tipo de mídia dos dados na solicitação. Ao incluir um corpo na solicitação REST, você deve especificar o tipo de mídia desse corpo no campo de cabeçalho Content-Type. Inclua o campo de cabeçalho Content-Type em solicitações PUT e POST. Tipo de mídia dos dados na resposta. Para especificar o formato da solicitação, use application/<json/xml> no cabeçalho ou adicione.json ou.xml à URL. O padrão é XML. Corpo da Solicitação Use o corpo da solicitação da API REST para enviar dados na solicitação. Um corpo de solicitação é usado com um método que pode ter um corpo conectado, como os métodos POST e PUT. O corpo dos dados é gravado após as linhas de cabeçalho. Se a mensagem da solicitação tiver um corpo, use o campo de cabeçalho Content-Type para especificar o formato do corpo no cabeçalho da solicitação. Os arquivos XSD (XML Schema Definition) descrevem quais elementos e atributos você pode usar. O conteúdo do corpo da solicitação depende dos tipos de elementos que você define nos arquivos XSD. Os arquivos XSD estão na seguinte localização: Formato XML Ao usar o formato de solicitação XML, defina o objeto de solicitação com um conjunto de marcas delimitante. Use o seguinte formato XML para definir um objeto de solicitação: <request object> <attribute1>value1</attribute1> <attribute2>value2</attribute2> </request object> O exemplo a seguir mostra a representação XML de um objeto de solicitação: <task> <tasktype> <name>updatewithapprovalworkflow</name> </tasktype> <taskid>urn:b4p2:5149</taskid> <owner>manager</owner> <title>smoke test task 222</title> <comments>smoke testing</comments> <duedate> t00:00:00</duedate> <status>open</status> <priority>normal</priority> <creator>admin</creator> <createdate> t00:00:00</createdate> <updatedby>admin</updatedby> <lastupdatedate> t00:00:00</lastupdatedate> <businessentity>person</businessentity> <orsid>localhost-orcl-ds_ui1</orsid> <processid>iddupdatewithapprovaltask</processid> <taskrecord> <businessentity> <name>person</name> <key> <rowid>123</rowid> <systemname></systemname> 32 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

33 </key> </businessentity> </taskrecord> </task> <sourcekey></sourcekey> Formato JSON Ao usar o formato de solicitação JSON, defina o objeto de solicitação com o atributo de tipo. Use o seguinte formato JSON para especificar um objeto de solicitação: "type"="<request object>" "<attribute1>": "<value1>", "<attribute2>": "<value2>", O exemplo a seguir mostra a representação JSON de um objeto de solicitação: "type"="task" tasktype: name:"updatewithapprovalworkflow", taskid: "urn:b4p2:5149", owner: "manager", title: "Smoke test task 222", comments: "Smoke testing", duedate: " T00:00:00", status: "OPEN", priority: "NORMAL", creator: "admin", createdate: " T00:00:00", updatedby: "admin", lastupdatedate: " T00:00:00", businessentity: "Person", orsid: "localhost-orcl-ds_ui1", processid: 'IDDUpdateWithApprovalTask', taskrecord: [ businessentity: name: 'Person', key: rowid: '123', systemname: '', sourcekey: '' ] Parâmetros de Consulta Padrão As APIs REST de serviços de entidade comercial usam parâmetros de consulta padrão para filtrar, paginar e expandir os resultados. Use um ponto de interrogação (?) para separar os parâmetros de consulta de outros parâmetros. Parâmetros de consulta são pares de chave/valor separados pelo sinal de igual. Use um E comercial (&) para separar uma sequência de parâmetros de consulta. O seguinte URL de solicitação REST mostra como usar parâmetros de consulta: /Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING Parâmetros de Consulta Padrão 33

34 Use os seguintes parâmetros de consulta padrão: Parâmetro Descrição recordstoreturn Especifica o número de linhas a serem retornadas. O padrão é 10. firstrecord searchtoken returntotal depth Especifica a primeira linha no resultado. O padrão é 1. Usado em chamadas subsequentes para ler mais páginas. Especifica o token de pesquisa retornado com a solicitação anterior. Você pode usar o token de pesquisa para buscar páginas subsequentes de resultados de pesquisa. Por exemplo, a seguinte consulta lista a primeira página: /Person/123/Phone A seguinte consulta retorna a segunda página: /Person/123/ Phone?searchToken=SVR1.AZAM5&firstRecord=10 Se definido como true, retorna o número de registros no resultado. O padrão é false. Especifica o número de níveis filho para inclusão no resultado. Configurando o WebLogic para Executar Chamadas REST de Serviço de Entidade Comercial Como as chamadas REST de Serviço de Entidade Comercial usam a autenticação HTTP básica, você deve desativar a autenticação do Servidor WebLogic para essas chamadas REST. Para configurar o WebLogic para a execução de chamadas REST de serviço de entidade comercial, edite o arquivo config.xml do WebLogic. 1. Navegue até o seguinte diretório do WebLogic: No UNIX. <WebLogic installation directory>/user_projects/domains/base_domain/config No Windows. <WebLogic installation directory>\user_projects\domains\base_domain\config 2. Abra o seguinte arquivo em um editor de texto: config.xml 3. Antes de fechar a marca </security-configuration>, adicione o seguinte código XML: <enforce-valid-basic-auth-credentials> false </enforce-valid-basic-auth-credentials> 34 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

35 Visualizando Parâmetros de Entrada e Saída Você pode usar uma ferramenta de testes funcionais, como a SoapUI, para visualizar os parâmetros de entrada e saída da API REST. Baixe o arquivo WADL e importe-o em seguida para a ferramenta de testes funcionais para criar um projeto REST. A imagem a seguir mostra os parâmetros de entrada na SoapUI para a API REST createperson: 1. Parâmetros de entrada para a API REST createperson Nota: O arquivo WADL produzido em ambientes WebSphere pode não ser importado corretamente na SoapUI. Se os parâmetros de entrada não aparecem na SoapUI, edite o arquivo WADL para remover o atributo xmlns de cada elemento param e depois importe o arquivo WADL novamente. Modelo JavaScript A seguinte amostra de código exibe um modelo básico que você pode modificar para criar um código JavaScript para chamadas de serviços de entidade comercial REST. Você precisa da biblioteca de script Java jquery. (function ($) window.csclient = window.csclient baseurl: "/cmx/cs/" + "[siperian-client.orsid]", user: "[siperian-client.username]", pass: "[siperian-client.password]", process: function (method, url, body, params) var fullurl = this.baseurl + url + ".json?" + $.param(params); return $.ajax( method: method, contenttype: "application/json", url: fullurl, data: JSON.stringify(body), beforesend: function (xhr) xhr.setrequestheader("authorization", "Basic " + btoa(csclient.user + ":" + CSClient.pass)); );, readco: function (url, params) return this.process("get", url, null, params); Visualizando Parâmetros de Entrada e Saída 35

36 , createco: function (url, body, params) return this.process("post", url, body, params);, updateco: function (url, body, params) return this.process("put", url, body, params);, deleteco: function (url, params) return this.process("delete", url, null, params); ; )(jquery); Exemplo de JavaScript O kit de recursos tem um código de origem Java de amostra que mostra como fazer chamadas de serviços de entidade comercial REST. O código de amostra está no seguinte arquivo: <diretório de instalação infamdm>\hub\resourcekit\samples\cos\source\resources\webapp\restapi.html O seguinte código mostra chamadas de API REST para criar um registro raiz Person, adicionar vários registros filho, excluir um registro filho e depois excluir o registro Person e todos os registros filho: <html> <head> <script type="text/javascript" src="jquery js"></script> <script type="text/javascript" src="cs-client.js"></script> </head> <body> <script type="text/javascript" language="javascript"> $(document).ready(function () $("#run").click(function () pre>"); log = function(msg, json) $('#log').before("<hr/><b>" + msg + "</b>"); $('#log').before("<pre>" + JSON.stringify(json, undefined, 2) + "</ ; CSClient.createCo( "/Person", firstname: "John", lastname: "Smith", systemname: "Admin" ).then( function (result) log("person CREATED:", result); return CSClient.readCo( "/Person/" + result.person.rowidobject.trim(), depth: 1 ); ).then( function (result) 36 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

37 log("read CREATED PERSON:", result); return CSClient.updateCo( "/Person/" + result.rowidobject.trim(), gendercd: gendercode: "M", TelephoneNumbers: item: [ phonenumber: " ", phonenumber: " " ], systemname: "Admin" ); ).then( function (result) log("person UPDATED:", result); return CSClient.readCo( "/Person/" + result.person.rowidobject.trim(), depth: 3, readsystemfields: true ); ).then( function (result) log("read UPDATED PERSON:", result); return CSClient.deleteCo( "/Person/" + result.rowidobject.trim() + "/ TelephoneNumbers/" + result.telephonenumbers.item[0].rowidobject.trim(), systemname: "Admin" ); ).then( function (result) log("telephone DELETED:", result); return CSClient.readCo( "/Person/" + result.person.rowidobject.trim(), depth: 3 ); ).then( function (result) log("read PERSON AFTER TELEPHONE IS DELETED:", result); return CSClient.deleteCo( "/Person/" + result.rowidobject.trim(), systemname: "Admin" ); ).then( function (result) log("person DELETED:", result); return CSClient.readCo( "/Person/" + result.person.rowidobject.trim(), Exemplo de JavaScript 37

38 ); ).then( ); ); depth: 1, recordstates: "ACTIVE,PENDING,DELETED", readsystemfields: true function (result) log("read PERSON AFTER DELETE (HSI -1):", result); ); </script> <input type="button" id="run" value="run..."/> <p/> <div id="log"></div> </body> </html> Referência de API REST para Serviços de Entidade Comercial A referência de API REST para serviços de entidade comercial lista as APIs REST e fornece uma descrição para cada uma. Ela também contém informações sobre os URLs, os parâmetros de consulta, as solicitações de amostra e as respostas de amostra. Obter Metadados A API REST Obter Metadados retorna a estrutura de dados de uma entidade comercial. A API usa o método GET para retornar os seguintes metadados de uma entidade comercial: Estrutura da entidade comercial Lista de campos Tipos de campos, como o tipo de dados e o tamanho Rótulos localizados para nós ou campos Nome dos campos de código e exibição para campos de pesquisa URL da Solicitação A URL de Obter Metadados tem o seguinte formato. ID>/<business entity>?action=meta Use o parâmetro de consulta "action=meta" para recuperar as informações de metadados. Certifique-se de especificar o nome da entidade comercial corretamente. Faça uma solicitação HTTP GET para a URL de Obter Metadados: GET ID>/<business entity>?action=meta É possível adicionar cabeçalhos HTTP à solicitação. 38 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

39 Solicitação de API de Amostra A seguinte solicitação de amostra recupera informações de metadados para o nó raiz e a entidade comercial Person: GET A seguinte solicitação de amostra inclui um cabeçalho para recuperar as informações de metadados da entidade comercial Person no formato JSON: GET Accept: application/json Resposta de API de Amostra O exemplo a seguir mostra um trecho da estrutura de dados da entidade comercial Person no formato JSON: "object": "field":[ "allowedvalues":[ "Person" ], "name":"partytype", "label":"party Type", "datatype":"string", "length":255, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false, "name":"dunsnumber", "label":"duns Number", "datatype":"string", "length":9, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false, "name":"boolfld", "label":"bool_fld", "datatype":"string", "length":1, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false, "name":"intfld", "label":"int_fld", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false, "name":"statuscd", "label":"status Cd", Referência de API REST para Serviços de Entidade Comercial 39

40 ,,,,,, "datatype":"string", "length":2, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"floatfld", "label":"float_fld", "datatype":"decimal", "length":0, "totaldigits":38, "fractiondigits":1, "readonly":false, "required":false, "system":false "name":"lastname", "label":"last Name", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":true, "system":false "name":"middlename", "label":"middle Name", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"imageurl", "label":"image_url", "datatype":"imageurl", "length":512, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"birthdate", "label":"birthdate", "datatype":"date", "length":0, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"firstname", "label":"first Name", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, "readonly":false, 40 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

41 ,,,,,,, "required":true, "system":false "name":"taxid", "label":"tax ID", "datatype":"string", "length":29, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"displayname", "label":"display Name", "datatype":"string", "length":200, "totaldigits":0, "fractiondigits":0, "readonly":false, "required":false, "system":false "name":"dirtyindicator", "label":"dirty Indicator", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"hubstateind", "label":"hub State Ind", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"cmdirtyind", "label":"content metadata dirty Ind", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"lastrowidsystem", "label":"last Rowid System", "datatype":"string", "length":14, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"deletedby", Referência de API REST para Serviços de Entidade Comercial 41

42 ,,,,,, "label":"deleted By", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"interactionid", "label":"interaction Id", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"deleteddate", "label":"deleted Date", "datatype":"date", "length":23, "totaldigits":23, "fractiondigits":3, "readonly":true, "required":false, "system":true "name":"rowidobject", "label":"rowid Object", "datatype":"string", "length":14, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"deletedind", "label":"deleted Indicator", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"lastupdatedate", "label":"last Update Date", "datatype":"date", "length":23, "totaldigits":23, "fractiondigits":3, "readonly":true, "required":false, "system":true "name":"updatedby", "label":"updated By", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, 42 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

43 ,,,, "readonly":true, "required":false, "system":true "name":"creator", "label":"creator", "datatype":"string", "length":50, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"consolidationind", "label":"consolidation Ind", "datatype":"integer", "length":38, "totaldigits":0, "fractiondigits":0, "readonly":true, "required":false, "system":true "name":"createdate", "label":"create Date", "datatype":"date", "length":23, "totaldigits":23, "fractiondigits":3, "readonly":true, "required":false, "system":true "name":"gendercd", "label":"gender Cd", "datatype":"lookup", "readonly":false, "required":false, "system":false, "lookup": "link":[ "href":" LUGender?action=list", "rel":"list", "href":" LUGender?action=list&idlabel=genderCode%3AgenderDisp", "rel":"lookup" ], "object":"lugender", "key":"gendercode", "value":"genderdisp", "name":"generationsuffixcd", "label":"generation Suffix Cd", "datatype":"lookup", "readonly":false, "required":false, "system":false, "lookup": "link":[ Referência de API REST para Serviços de Entidade Comercial 43

44 "href":" LUGenerationSuffix?action=list&idlabel=generationSuffixCode%3AgenerationSuffixCode", "rel":"lookup", "href":" LUGenerationSuffix?action=list", "rel":"list" ], "object":"lugenerationsuffix", "key":"generationsuffixcode", "value":"generationsuffixcode", "name":"nameprefixcd", "label":"name Prefix Cd", "datatype":"lookup", "readonly":false, "required":false, "system":false, "lookup": "link":[ "href":" LUNamePrefix?action=list&idlabel=namePrefixCode%3AnamePrefixDisp", "rel":"lookup", "href":" LUNamePrefix?action=list", "rel":"list" ], "object":"lunameprefix", "key":"nameprefixcode", "value":"nameprefixdisp" Ler Entidade Comercial A API REST Ler Entidade Comercial retorna os detalhes de um registro raiz na entidade comercial. É possível usar a API para retornar os detalhes dos registros filho de um registro raiz. É possível usar a API para exibir os metadados de conteúdo de um registro. A API usa o método GET. URL da Solicitação Use a ID de linha ou o nome do sistema de origem e a chave de origem para especificar o registro na URL da solicitação. A URL de Ler Entidade Comercial pode ter os seguintes formatos: URL com rowid Use o seguinte formato de URL ao especificar o ID de linha: ID>/<business entity>/<rowid of the business entity root record> 44 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

45 Faça a seguinte solicitação HTTP GET para a URL: GET ID>/<business entity>/<rowid of the business entity root record> URL com o nome do sistema de origem e a chave de origem Use o seguinte formato de URL ao especificar o nome do sistema de origem e a chave de origem: ID>/<business entity>/<system name>:<source key> URL com o nome do sistema e o identificador comercial global (GBID) de um objeto Use o seguinte formato de URL ao especificar o nome do sistema de origem e o GBID: ID>/<business entity>/<system name>:uid:<gbid> URL somente com o GBID Use o seguinte formato de URL ao especificar somente o GBID: ID>/<business entity>/:uid:<gbid> URL com mais de um GBID Use o seguinte formato de URL ao especificar mais de um GBID: ID>/<business entity>/:one:<gbid>,another:<gbid> URL para retornar os dados dos nós filho Use o seguinte formato de URL para retornar os detalhes dos nós filho: ID>/<business entity>/<rowid of the business entity record>?depth=n URL para retornar os dados de nós filho Use o seguinte formato de URL para retornar os detalhes de nós filho: ID>/<business entity>/<rowid of the business entity record>?children=<comma separated list of child node names or paths> Por exemplo, children= BillAddresses/Address, URL para retornar os detalhes de um determinado nó Use o seguinte formato de URL para retornar os detalhes de um determinado nó: ID>/<business entity>/<rowid of the business entity record>/<node name> URL para retornar os detalhes dos filhos de um determinado nó Use o seguinte formato de URL para retornar os detalhes dos filhos de um determinado nó: ID>/<business entity>/<rowid of the business entity record>/<node name>?children=<child node name> URL para retornar os metadados de conteúdo de um registro Use o seguinte formato de URL para retornar os metadados de conteúdo de um registo: ID>/<business entity>/<rowid of the business entity root record>?contentmetadata=<content metadata type> Referência de API REST para Serviços de Entidade Comercial 45

46 Parâmetros de Consulta Você pode acrescentar os parâmetros de consulta à URL da solicitação para filtrar os detalhes do registro. A seguinte tabela lista os parâmetros de consulta: Parâmetro depth effectivedate readsystemfields recordstates contentmetadata filhos Descrição Número de níveis filho a serem retornados. Especifique 2 para retornar o nó raiz e seus filhos diretos e 3 para retornar o nó raiz, os filhos diretos e os netos. O padrão é 1. Data para a qual você deseja recuperar os dados. Use o formato ISO 8601: para especificar a data. Indica se os campos do sistema devem ou não ser retornados no resultado. O padrão é false. Estado do registro. Forneça uma lista de estados separada por vírgulas. Os estados de registro com suporte são ACTIVE, PENDING e DELETED. O padrão é ACTIVE. Metadados do registro. Forneça uma lista separada por vírgulas. Por exemplo, XREF, PENDING_XREF, DELETED_XREF, HISTORY e XREF_HISTORY. Lista separada por vírgulas de nós ou caminhos de nós filho. O seguinte exemplo mostra como filtrar os detalhes de um registo: GET PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF Solicitações de API de Amostra A seguinte solicitação de amostra retorna os detalhes do registro raiz na entidade comercial Person. GET A solicitação de amostra a seguir retorna os detalhes de um registro filho com o rowid 2. O objeto base filho é gendercd, e o registro filho está a uma profundidade de 2. GET A seguinte solicitação de amostra usa o nome do sistema e a chave de origem para retornar os detalhes do registro raiz: GET A seguinte solicitação de amostra retorna os detalhes do registro raiz e seus registros XREF: GET Resposta de API de Amostra O exemplo a seguir mostra os detalhes do registro raiz na entidade comercial Person. "link": [ "href": " "rel": "self", "href": " depth=2", 46 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

47 "rel": "children" ], "rowidobject": "102 ", "label": "DARWENT,JIMMY", "partytype": "Person", "statuscd": "A ", "lastname": "DARWENT", "middlename": "N", "firstname": "JIMMY", "displayname": "JIMMY N DARWENT", "gendercd": "link": [ "href": " "rel": "parent", "href": " gendercd", "rel": "self", "href": " gendercd?depth=2", "rel": "children" ], "gendercode": "M", "generationsuffixcd": "link": [ "href": " "rel": "parent", "href": " generationsuffixcd?depth=2", "rel": "children", "href": " generationsuffixcd", "rel": "self" ], "generationsuffixcode": "I" O exemplo a seguir mostra os detalhes de um registro filho no objeto base gendercd. "link": [ "href": " "rel": "parent", "href": " gendercd/2?depth=2", "rel": "children", "href": " gendercd/2", "rel": "self" ], "rowidobject": "2 ", Referência de API REST para Serviços de Entidade Comercial 47

48 "label": "LU Gender", "genderdisp": "MALE", "gendercode": "M" Criar Entidade Comercial A API REST Criar Entidade Comercial cria um registro na entidade comercial especificada. Envie os dados da entidade comercial no corpo da solicitação. Use a API Promover para promover e adicionar o registro na entidade comercial. A API usa o método POST para criar um registro. URL da Solicitação A URL de Criar Entidade Comercial tem o seguinte formato: ID>/<business entity>?systemname=<name of the source system> Nota: O nome do sistema de origem é um parâmetro necessário na URL. Faça a seguinte solicitação HTTP POST para a URL de Criar Entidade Comercial: POST ID>/<business entity>?systemname=<name of the source system> Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: POST ID>/<business entity>?systemname=<name of the source system> Content-Type: application/<json/xml> Parâmetros de URL O nome do sistema de origem é um parâmetro necessário na URL da solicitação. A seguinte tabela lista os parâmetros que podem ser usados na URL: Parâmetro systemname interactionid startdate e enddate validateonly recordstate Descrição Nome do sistema de origem. ID da interação. É possível agrupar várias solicitações em uma única interação. Todas as alterações são feitas com o ID de interação. Especifica o período de tempo durante o qual o registro está efetivo. Forneça esses parâmetros para um objeto base ativado para linha do tempo. Use o formato ISO 8601: para especificar as datas. Indica se o serviço de gravação de entidade comercial valida os dados de entrada. O padrão é false. Estado do registro. Use o parâmetro para especificar o estado inicial do registro. Use ACTIVE ou PENDING. O padrão é ACTIVE. 48 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

49 Corpo da Solicitação Envie dados para o registro de entidade comercial no corpo da solicitação REST. Use o formato JSON ou XML para enviar dados. Use a API Obter Metadados para obter a estrutura do registro de entidade comercial e forneça os valores de parâmetros necessários no corpo da solicitação. Cabeçalho e Corpo da Resposta Quando a resposta for bem-sucedida, a API retornará interactionid e processid no cabeçalho da resposta e retornará os detalhes do registro no corpo da resposta. Se o processo gerar um ID de interação e usá-lo para criar a entidade comercial, a API retornará esse ID de interação. Se o processo iniciar um fluxo de trabalho em vez de salvar diretamente o registro no banco de dados, a API retornará o ID do processo, que é o ID do processo de fluxo de trabalho. O exemplo a seguir mostra um cabeçalho de resposta com um ID de interação e um ID de processo: BES-interactionId: BES-processId: O corpo da resposta contém o registro de entidade comercial com os rowids gerados. Solicitação de API de Amostra A seguinte solicitação de amostra cria um registro de entidade comercial na entidade comercial Person: POST Content-Type: application/json firstname: "John", lastname: "Smith", Phone: item: [ phonenumber: " " ] Resposta de API de Amostra A seguinte resposta de amostra exibe o cabeçalho e o corpo da resposta após a criação bem-sucedida de um registro de entidade comercial: BES-interactionId: BES-processId: Content-Type: application/json "Person": "key": "rowid": " ", "sourcekey": " ", "rowidobject": " ", "Phone": "item": [ "key": "rowid": "260961", "sourcekey": " ", "rowidobject": "260961" Referência de API REST para Serviços de Entidade Comercial 49

50 ] Atualizar Entidade Comercial A API REST Atualizar Entidade Comercial atualiza o registro raiz de entidade comercial especificado e seus registros filho. Envie o ID do registro na URL da solicitação. Envie o resumo das alterações no corpo da solicitação. Use a API Promover para promover as alterações. A API usa o método PUT. URL da Solicitação A URL de Atualizar Entidade Comercial tem o seguinte formato: ID>/<business entity>/<rowid>?systemname=<name of the source system> Nota: O nome do sistema de origem é um parâmetro necessário na URL. Faça a seguinte solicitação HTTP PUT para a URL de Atualizar entidade comercial: POST ID>/<business entity>/<rowid>? systemname=<name of the source system> Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: PUT ID>/<business entity>/<rowid>? systemname=<name of the source system> Content-Type: application/<json/xml> Parâmetros de URL O nome do sistema de origem é um parâmetro de URL necessário. É possível usar os seguintes parâmetros de URL na solicitação: Parâmetro systemname interactionid startdate e enddate validateonly recordstate Descrição Nome do sistema de origem. ID da interação. É possível agrupar várias solicitações em uma única interação. Todas as alterações são feitas com o ID de interação. Especifica o período de tempo durante o qual o registro está efetivo. Forneça esses parâmetros para um objeto base ativado para linha do tempo. Use o formato ISO 8601: para especificar as datas. Indica se o serviço de gravação de entidade comercial valida os dados de entrada. O padrão é false. Estado do registro. Use ACTIVE, PENDING ou DELETED. 50 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

51 Corpo da Solicitação Envie os dados a serem atualizados no corpo da solicitação REST. Use o formato JSON ou XML para enviar os dados. Forneça os novos valores de parâmetros. Use o parâmetro $original para indicar o valor antigo de um parâmetro que você deseja atualizar. O seguinte corpo de solicitação altera o nome para Bob: rowidobject: "123", firstname: "Bob", lastname: "Smith", $original: firstname: "John" Cabeçalho da Resposta Quando a resposta for bem-sucedida, a API retornará interactionid e processid no cabeçalho da resposta e retornará os detalhes do registro no corpo da resposta. Se o processo gerar um ID de interação e usá-lo para criar a entidade comercial, a API retornará esse ID de interação. Se o processo iniciar um fluxo de trabalho em vez de salvar diretamente o registro no banco de dados, a API retornará o ID do processo, que é o ID do processo de fluxo de trabalho O exemplo a seguir mostra um cabeçalho de resposta com um ID de interação e um ID de processo: BES-interactionId: BES-processId: O corpo da resposta contém o registro de entidade comercial com os rowids gerados. Solicitação de API de Amostra A seguinte solicitação de amostra atualiza um registro raiz e seu registro filho em uma entidade comercial. Person é a entidade comercial e Phone é um objeto base filho. PUT rowidobject: "233", firstname: "BOB", lastname: "LLOYD", Phone: item: [ rowidobject: "164", phonenumber: " ", $original: phonenumber: "(336) " ], $original: firstname: "DUNN" Referência de API REST para Serviços de Entidade Comercial 51

52 Resposta de API de Amostra A seguinte resposta de amostra exibe o cabeçalho e o corpo da resposta após a atualização bem-sucedida de um registro de entidade comercial: BES-interactionId: BES-processId: Person: key: rowid: "233", sourcekey: "SYS:233", rowidobject: "233", preferredphone: key: Excluir Entidade Comercial A API REST Excluir Entidade Comercial exclui um registro raiz em uma entidade comercial. Use a API para excluir os registros filho de um registro raiz. A API usa o método DELETE para excluir um registro. URL da Solicitação A URL de Excluir Entidade Comercial tem o seguinte formato: ID>/<business entity>/<rowid of the business entity root record>?systemname=admin Nota: O nome do sistema de origem como um parâmetro necessário na URL. Faça a seguinte solicitação HTTP DELETE para a URL de Excluir Entidade Comercial: DELETE ID>/<business entity>/<rowid of the business entity record>?systemname=admin Use o seguinte formato de URL para excluir um registro filho de um registro raiz: DELETE ID>/<business entity>/<rowid of the business entity record>/<child base object>/<rowid of the child record>?systemname=admin Parâmetro de Consulta O nome do sistema de origem é um parâmetro de URL necessário. Use o parâmetro systemname para especificar o sistema de origem. Solicitação de API de Amostra A seguinte solicitação de amostra exclui um registro raiz na entidade comercial Person: DELETE 52 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

53 Resposta de API de Amostra A seguinte resposta de amostra exibe a resposta após a exclusão bem-sucedida de um registro raiz na entidade comercial Person: "Person": "key": "rowid": "292258", "sourcekey": "WRK50000_7016", "rowidobject": "292258" Listar Entidade Comercial A API REST Listar Entidade Comercial retorna a lista de valores de pesquisa ou de valores de chave externa. Pesquisas fornecem dados de referência e uma lista dos valores possíveis para uma determinada coluna. A API usa o método GET. Use a API para obter também os valores e as descrições do código de pesquisa. URL da Solicitação A URL REST de Listar Entidade Comercial tem o seguinte formato: ID>/<lookup table>?action=list Faça a seguinte solicitação HTTP GET para a URL: GET ID>/<lookup table>?action=list Use o seguinte formato de URL para listar os códigos dos valores de pesquisa: ID>/<lookup table>?action=list&idlabel=<lookup code>%3a<lookup display name> Solicitação de API de Amostra A seguinte solicitação de amostra lista os valores de pesquisa: GET A seguinte solicitação de amostra lista os códigos dos valores de pesquisa: GET action=list&idlabel=gendercode%3agenderdisp Resposta de API de Amostra A seguinte resposta de amostra exibe a lista de valores de pesquisa: "firstrecord": 1, "pagesize": , "searchtoken": "SVR1.AU5LC", "item": [ "rowidobject": "1 ", "genderdisp": "UNKNOWN", "gendercode": "N", Referência de API REST para Serviços de Entidade Comercial 53

54 ], "rowidobject": "2 ", "genderdisp": "MALE", "gendercode": "M" "rowidobject": "3 ", "genderdisp": "FEMALE", "gendercode": "F" A seguinte resposta de amostra exibe o código para os valores de pesquisa: "item": [ "id": "F", "label": "FEMALE", "id": "M", "label": "MALE", "id": "N", "label": "UNKNOWN" ], "firstrecord": 1, "recordcount": 0, "pagesize": , "searchtoken": "SVR1.AU5LD" Pesquisar Entidade Comercial A API REST de Pesquisar Entidade Comercial procura valores indexados em uma entidade comercial raiz pesquisável e em todos os registros filho. É possível usar filtros e facetas para visualizar um subconjunto dos resultados da pesquisa. Facetas agrupam os resultados da pesquisa em categorias, enquanto filtros restringem esses resultados. A API pesquisa todos os campos configurados como pesquisáveis e retorna os registros que correspondem aos critérios de pesquisa. A API usa o método GET para pesquisar os índices dos campos pesquisáveis. URL da Solicitação A URL de Pesquisar Entidade Comercial tem os seguintes formatos: URL para uma pesquisa simples Use a seguinte URL para uma pesquisa simples: ID>/<business entity>?q=<string value> Faça a seguinte solicitação HTTP GET para a URL de Pesquisar Entidade Comercial: GET ID>/<business entity>?q=<string value> URL para uma pesquisa em campo Use a seguinte URL para uma pesquisa em campo: ID>/<business entity>?fq=<business entity field name>='<business entity field value>' 54 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

55 URL para uma pesquisa de facetas Use a seguinte URL para uma pesquisa simples com facetas: ID>/<business entity>?q=<string value>&facets=<field name> Use a seguinte URL para uma pesquisa em campo com facetas: ID>/<business entity>?fq=<business entity field name>='<business entity field value>'&facets=<field name> URL para uma pesquisa de filtro Use a seguinte URL para uma pesquisa simples com filtros: ID>/<business entity>?q=<string value>&filters=<field name1>=<field value1> AND <field name2>=<field value2>... Use o parâmetro q ou fq na pesquisa. Codificação de URL Use a codificação de URL porque a URL inclui caracteres, como espaços e aspas simples. O exemplo a seguir mostra a representação codificada em URL da URL de Pesquisar Entidade Comercial: ID>/<business entity>?q=<field name>%3d %27<value of the field> Referência de API REST para Serviços de Entidade Comercial 55

56 Parâmetros de Consulta Use os parâmetros de consulta q ou fq para fornecer o valor de cadeia para a pesquisa. Os parâmetros de consulta q e fq são mutuamente exclusivos. Use o parâmetro fq para uma pesquisa em campo. Equivalente ao operador lógico AND para várias condições. A seguinte tabela lista os parâmetros que podem ser usados na URL: Parâmetro q Descrição Especifica o valor da cadeia ou o termo de pesquisa. A consulta procura ocorrências do termo de pesquisa em qualquer lugar de um registro. Usado em uma pesquisa simples. Por exemplo, a consulta Person?q=STEVE procura registros com o termo STEVE. Para procurar dois ou mais termos em conjunto, coloque-os entre aspas duplas. Use o caractere + antes de cada termo se quiser que os resultados da pesquisa contenham o termo em questão. Se o valor do campo contiver um espaço, coloque esse valor entre aspas simples. Use a seguinte consulta para procurar uma correspondência exata para WILLIAM JOHN LAWSON: Person?q="WILLIAM JOHN LAWSON" Use a seguinte consulta para procurar WILLIAM, JOHN ou LAWSON: Person?q=WILLIAM JOHN LAWSON fq facets Especifica o valor da cadeia ou o termo de pesquisa em um campo específico. A consulta procura o termo somente na parte de um registro. Usado em uma pesquisa direcionada com base em campos indexados. Por exemplo, a consulta Person? fq=displaname=steve procura registros com o nome de exibição STEVE. Especifica os campos que devem ser tratados como facetas ou categorias de acordo com as quais os resultados de pesquisas são agrupados. Especifique apenas campos pesquisáveis. Usado com os parâmetros q e fq. A sintaxe é &facets=fieldname1,fieldname2,fieldname N Por exemplo, a consulta Person? q=steve&facets=department procura pessoas com o nome de exibição STEVE e agrupa os resultados da pesquisa por departamento. A pesquisa mostra os registros das pessoas com o nome de exibição STEVE, e esses registros são agrupados por departamento. 56 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

57 Parâmetro filters depth Descrição Especifica os campos com base nos quais você pode restringir os resultados da pesquisa. Especifique apenas campos filtráveis. Usado com os parâmetros q e fq. Por exemplo, a consulta Person? fq=steve&filters=birthdate=' t 08:00:00Z' procura pessoas com o nome de exibição STEVE e filtra os resultados da pesquisa por data de nascimento. A pesquisa mostra os registros das pessoas que têm o nome de exibição STEVE e cuja data de nascimento é 27 de novembro de Nota: Especifique uma data entre aspas simples. Especifica o número de níveis filho a serem retornados. Especifique 2 para retornar o nó raiz e seus filhos diretos e 3 para retornar o nó raiz, os filhos diretos e os netos. O padrão é 1. Por exemplo, a consulta Person? q=steve&depth=2 procura registros com o termo STEVE e retorna informações sobre o registro raiz e seus filhos diretos. Especifique uma faixa com o parâmetro filters: É possível usar o parâmetro filters para restringir os resultados da pesquisa dentro de uma faixa especificada. Você pode especificar a faixa para campos filtráveis dos tipos de dados numéricos e de data. Use o seguinte formato para o tipo de dados de número inteiro : fieldname1=[fromvalue,tovalue] A faixa é de fromvalue até tovalue. Por exemplo, a consulta filters=age=[35,45] restringe os resultados da pesquisa e procura registros na faixa etária de 35 a 45. Use o seguinte formato para o tipo de dados de data: fieldname1=[fromdate,todate] A faixa é de fromdate até todate. Por exemplo, a consulta filters=birthdate=[ t12:30:00z, T12:30:00Z] especifica a data de nascimento entre 12 de junho de 2000 e 12 de junho de Nota: Quando especificar um filtro de data com correspondência exata, coloque entre aspas simples. Ao especificar uma faixa de datas, não use aspas. Solicitação de API de Amostra Solicitação com o parâmetro q A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome STEVE. GET Solicitação com o parâmetro fq A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome de exibição STEVE. O campo displayname é um campo indexado. GET Referência de API REST para Serviços de Entidade Comercial 57

58 Solicitação com o parâmetro fq e o operador lógico AND A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome de exibição STEVE e o ID fiscal DM106: GET AND taxid=dm106 Solicitação com uma faceta A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome de exibição STEVE e restringe os resultados agrupando-os em departamentos: GET fq=displayname=steve&facets=department Solicitação com um filtro (filtro exato) A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome de exibição STEVE e filtra de acordo com a cidade e o país especificados: GET fq=displayname=steve&filters=cityname=canberra AND country=australia Solicitação com uma faixa de filtros A seguinte solicitação de amostra pesquisa a entidade comercial Person em busca de registros com o nome de exibição STEVE e filtra de acordo com a faixa etária de 35 a 45: GET fq=displayname=steve&filters=age=[35,45] AND cityname=canberra Resposta de API de Amostra A seguinte resposta de amostra exibe o resultado de uma pesquisa pelo nome STEVE: "firstrecord": 1, "recordcount": 2, "pagesize": 10, "item": [ "Person": "link": [ "href": " Person/1443", "rel": "self", "href": " Person/1443?depth=2", "rel": "children" ], "rowidobject": "1443 ", "label": "CRAIG,STEVE", "partytype": "Person", "lastname": "CRAIG", "firstname": "STEVE", "taxid": "stevecraig ", "displayname": "STEVE CRAIG", "Person": "link": [ "href": " 58 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

59 Person/285", "rel": "self", "href": " Person/285?depth=2", "rel": "children" ], "rowidobject": "285 ", "label": "PEARSON,STEVE", "partytype": "Person", "lastname": "PEARSON", "firstname": "STEVE", "displayname": "STEVE PEARSON" ] Agente de Sugestão A API REST de Agente de Sugestão retorna uma lista de termos relacionados para uma cadeia de pesquisa, com base nos dados presentes no banco de dados. Use essa API para aceitar os caracteres que você digita em um campo da interface do usuário e retornar sugestões de preenchimento automático para o conteúdo inserido. É possível localizar e selecionar a cadeia na lista de sugestões. Use a API de Agente de Sugestão para campos pesquisáveis. A API usa o método GET. Nota: Para usar a API para fornecer uma lista de sugestões de preenchimento automático para um campo pesquisável, defina a propriedade suggester do campo como "true" e reindexe os dados. URL da Solicitação A URL REST do Agente de Sugestão tem o seguinte formato: ID>/<business entity>?suggest=<string> Faça a seguinte solicitação HTTP GET para a URL: GET ID>/<business entity>?suggest=<string> Nota: Quando você reiniciar o sistema, porque o índice do agente de sugestão não está presente, construa esse índice definindo o parâmetro buildindex como true: ID>/<business entity>? suggest=<string>&buildindex=true Referência de API REST para Serviços de Entidade Comercial 59

60 Parâmetros de Consulta A seguinte tabela lista os parâmetros de consulta: Parâmetro suggest recordstoreturn buildindex Descrição Obrigatório. Especifica a cadeia para a qual você deseja sugestões. Especifica o número de linhas a serem retornadas. Opcional. Indica se o índice deve ou não construído. Quando você reiniciar o sistema, defina esse parâmetro como "true" de forma a construir explicitamente o índice para a coleta. Esse parâmetro pode ficar obsoleto em uma versão futura. Solicitação de API de Amostra A seguinte solicitação de amostra retorna uma lista de sugestões que você pode usar em uma interface de usuário: GET Resposta de API de Amostra A seguinte resposta de amostra exibe a lista de sugestões: term: [2] "abhinav goel" "abhinav gupta" Obter Metadados do BPM A API REST Obter Metadados do BPM retorna os tipos de tarefas e dois indicadores que especificam se a ferramenta de fluxo de trabalho do BPM pode executar o serviço Obter Linhagem de Tarefas e os serviços de administração. A API usa o método GET. URL da Solicitação A URL de Obter Metadados do BPM tem o seguinte formato: ID>/BPMMetadata Faça a seguinte solicitação HTTP GET para a URL de Obter Metadados do BPM: GET ID>/BPMMetadata Solicitação de API de Amostra A seguinte solicitação de amostra a seguir retorna informações sobre os tipos de tarefa e a ferramenta de fluxo de trabalho do BPM: GET 60 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

61 Resposta de API de Amostra A seguinte resposta de amostra exibe os tipos de tarefas e o valor dos dois indicadores para a ferramenta de fluxo de trabalho do BPM: "parameters": "tasktypes": "tasktypes": [ "name": "Merge", "label": "Merge", "name": "FinalReview", "label": "FinalReview", "name": "Update", "label": "Update", "name": "Notification", "label": "Notification", "name": "ReviewNoApprove", "label": "ReviewNoApprove", "name": "Unmerge", "label": "Unmerge" ], "doessupportadministration": true, "doessupportlineage": true Listar Tarefas A API Listar Tarefas retorna uma lista de tarefas de fluxo de trabalho. Um fluxo de trabalho define as atividades em um processo comercial e os caminhos de execução através das atividades. Cada atividade é chamada de tarefa. A API usa o método GET para retornar uma lista de tarefas classificada e paginada. URL da Solicitação A URL de Listar Tarefas tem o formato a seguir. ID>/task Faça a seguinte solicitação HTTP GET para a URL de Listar Tarefas: GET ID>/task É possível adicionar cabeçalhos HTTP à solicitação. Referência de API REST para Serviços de Entidade Comercial 61

62 Parâmetros de Consulta Use os campos de dados de tarefas como parâmetros de consulta para filtrar a lista de tarefas. É possível usar os seguintes parâmetros de consulta: Parâmetro tasktype taskid processid owner title status priority creator createdatebefore e createdateafter duedatebefore e duedateafter Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Use o atributo name para especificar o tipo de tarefa. Para obter mais informações sobre tipos de tarefas, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. O ID da tarefa. O ID do processo de fluxo de trabalho que contém essa tarefa. O usuário que realiza a tarefa. Descrição resumida da tarefa. Status da tarefa no fluxo de trabalho. Use um destes dois valores: - Open: a tarefa não foi iniciada ou está em andamento. - Closed: a tarefa está concluída ou foi cancelada. Nível de importância da tarefa. Use um dos seguintes valores: high, normal e low. Usuário que cria a tarefa. Faixa de datas. É possível filtrar as tarefas com base no campo createdate. Use o formato ISO 8601: para especificar a data. Faixa de datas. É possível filtrar as tarefas com base no campo duedate. Use o formato ISO 8601: para especificar a data. Use os parâmetros de consulta como pares de nome/valor na URL da solicitação. O seguinte exemplo mostra como usar os parâmetros de consulta para filtrar tarefas: GET recordstoreturn=100&owner=sergey&status=open Parâmetros de Classificação Para determinar a ordem de classificação na resposta da API REST, use o parâmetro de classificação genérico e forneça uma lista de campos de tarefa separados por vírgulas. Você pode especificar a ordem de 62 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

63 classificação para cada campo. Use o sinal de traço (-) para especificar a ordem decrescente. A ordem de classificação padrão é crescente. A amostra a seguir exibe como classificar os resultados: GET recordstoreturn=100&owner=sergey&status=open&sort=-priority Solicitação de API de Amostra A seguinte solicitação de amostra recupera a lista de tarefas: GET A solicitação não contém um corpo. Resposta de API de Amostra A seguinte resposta de amostra exibe a lista de tarefas no formato JSON: "firstrecord": 1, "recordcount": 10, "pagesize": 10, "task": [ "link": [ "href": " urn:b4p2:15443", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:15443", "title": "Review changes in SMITH,SMITH", "duedate": " T21:45:59-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:15440", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:15440", "title": "Review changes in SMITH,JOHN", "duedate": " T21:37:50-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", Referência de API REST para Serviços de Entidade Comercial 63

64 "link": [ "href": " urn:b4p2:15437", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:15437", "title": "Review changes in SMITH,JOHN", "duedate": " T21:34:32-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:14820", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14820", "title": "Review changes in STAS,STAS", "duedate": " T10:40:51-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:14809", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14809", "title": "Review changes in,93c8orscofsa687", "duedate": " T08:28:15-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:14609", 64 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

65 , "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14609", "title": "Review changes in A8,A8", "duedate": " T08:40:11-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person" "link": [ "href": " urn:b4p2:14425", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14425", "title": "Review changes in A7,A7", "duedate": " T14:11:02-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:14422", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14422", "title": "Review changes in A6,A6", "duedate": " T13:54:09-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person", "link": [ "href": " urn:b4p2:14415", "rel": "self" ], "tasktype": "name": "ReviewNoApprove", Referência de API REST para Serviços de Entidade Comercial 65

66 Ler Tarefa, "label": "Review No approve", "taskkind": "REVIEW", "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:14415", "title": "Review changes in A5,A5", "duedate": " T13:51:12-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person" "link": [ "href": " urn:b4p2:14355", "rel": "self" ], "tasktype": "name": "Notification", "label": "Notification", "taskkind": "REVIEW", "pendingbvt": false, "updatetype": "ACTIVE", "taskid": "urn:b4p2:14355", "title": "Review changes in A4,A4", "duedate": " T10:31:57-07:00", "status": "OPEN", "priority": "NORMAL", "businessentity": "Person" ] A API REST Ler Tarefa retorna os detalhes de uma tarefa, como tipo de tarefa, prioridade e status. A API usa o método GET. URL da Solicitação A URL de Ler Tarefa tem o seguinte formato: ID>/task/<taskId> Nota: Use a API Listar Tarefas para obter o ID da tarefa. Faça a seguinte solicitação HTTP GET para a URL de Ler Tarefa: GET ID>/task/<taskId> Solicitação de API de Amostra A seguinte solicitação de amostra retorna os detalhes de uma tarefa: GET 66 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

67 Resposta de API de Amostra A seguinte resposta de amostra exibe os detalhes da tarefa: "tasktype": "name": "ReviewNoApprove", "label": "Review No Approve", "taskkind": "REVIEW", "taskaction": [ "name": "Escalate", "label": "Escalate", "manualreassign": false, "closetaskview": true, "canceltask": false, "name": "Reject", "label": "Reject", "manualreassign": false, "closetaskview": true, "canceltask": false, "name": "Disclaim", "label": "Disclaim", "manualreassign": false, "closetaskview": true, "canceltask": false ], "pendingbvt": true, "updatetype": "PENDING", "taskid": "urn:b4p2:16605", "processid": "16603", "title": "Review changes in HERNANDEZ,ALEJANDRO", "duedate": " T01:18: :00", "status": "OPEN", "priority": "NORMAL", "taskrecord": [ "businessentity": "key": "rowid": "114", "sourcekey": "SYS:114", "name": "Person", "businessentity": "key": "rowid": "114 ", "sourcekey": "SYS:114", "rowidxref": " ", "name": "Person.XREF" ], "creator": "avos", "createdate": " T01:18: :00", "businessentity": "Person", "interactionid": " ", "orsid": "localhost-orcl-ds_ui1" Referência de API REST para Serviços de Entidade Comercial 67

68 Criar Tarefa A API REST Criar Tarefa cria uma tarefa e inicia um fluxo de trabalho. A API usa o método POST para criar uma tarefa e retorna o ID do processo de fluxo de trabalho que contém essa tarefa. URL da Solicitação A URL de Criar Tarefa tem o seguinte formato: ID>/task Faça a seguinte solicitação HTTP POST para a URL de Criar Tarefa: POST ID>/task Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: POST ID>/task Content-Type: application/<json/xml> Corpo da Solicitação Especifique os atributos da tarefa ao criar a tarefa. Use o formato JSON ou XML para enviar os dados de tarefas na solicitação. A seguinte tabela descreve os parâmetros de tarefas no corpo da solicitação: Parâmetro tasktype owner title comments duedate status priority creator createdate Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Use o atributo name para especificar o tipo de tarefa. Para obter mais informações sobre tipos de tarefas, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. Usuário ao qual o criador atribui a tarefa. Descrição resumida da tarefa. Comentários para a tarefa. Data na qual o proprietário deve concluir a tarefa. Use o formato ISO 8601: para especificar a data. Status da tarefa no fluxo de trabalho. Use um destes dois valores: - Open: a tarefa não foi iniciada ou está em andamento. - Closed: a tarefa está concluída ou foi cancelada. Nível de importância da tarefa. Use um dos seguintes valores: high, normal e low. O padrão é normal. Usuário que cria a tarefa. Data em que a tarefa é criada. Use o formato ISO 8601: para especificar a data. 68 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

69 Parâmetro orsid processid taskrecord businessentity Descrição O ID do ORS (Armazenamento de Referências Operacionais) registrado na ferramenta Bancos de Dados do Console do Hub. ID do tipo de tarefa do ActiveVOS. Para obter mais informações, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. O registro raiz do objeto comercial ou o registro de referência cruzada associado à tarefa. Use o ID de linha ou o sistema de origem e a chave de origem para especificar o registro. Nome da entidade comercial à qual taskrecord pertence. O seguinte código de amostra usa rowid para especificar taskrecord: taskrecord: [ businessentity: name: 'Person', key: rowid: '233', systemname: '', sourcekey: '' ] A corpo da solicitação tem o seguinte formato: tasktype: name:"name of the task", taskid: "", owner: "user who performs the task", title: "title of the task", comments: "description of the task", duedate: "date to complete the task", status: "status of the task", priority: "priority of the task", creator: "use who creates the task", createdate: "date on which the task is created", updatedby: "user who last updated the task", lastupdatedate: "date on which the task was last updated", businessentity: "name of the business entity", orsid: "database ID", processid: 'ActiveVOS task type ID', taskrecord: [ businessentity: name: 'name of the business entity', key: rowid: 'rowid of the record',//use the rowid or the source system and source key to identify the record. systemname: '', sourcekey: '' ] Solicitação de API de Amostra A seguinte solicitação de amostra cria uma tarefa para um registro raiz: POST tasktype: name:"updatewithapprovalworkflow", Referência de API REST para Serviços de Entidade Comercial 69

70 taskid: "", owner: "manager", title: "Smoke test task", comments: "Smoke testing", duedate: " T00:00:00", status: "OPEN", priority: "NORMAL", creator: "admin", createdate: " T00:00:00", updatedby: "admin", lastupdatedate: " T00:00:00", businessentity: "Person", orsid: "localhost-orcl-ds_ui1", processid: 'IDDUpdateWithApprovalTask', taskrecord: [ businessentity: name: 'Person', key: rowid: '123', systemname: '', sourcekey: '' ] Resposta de API de Amostra O exemplo a seguir mostra a resposta na criação bem-sucedida de uma tarefa. A API retorna o ID do processo de fluxo de trabalho que contém essa tarefa. "parameters": "processid": "15827" Atualizar Tarefa A API REST Atualizar Tarefa atualiza uma única tarefa. A API usa o método PATCH para atualizar alguns campos de tarefas e o método PUT para atualizar a tarefa completa. Forneça o ID da tarefa como o parâmetro de URL. URL da Solicitação A URL de Atualizar Tarefa tem o seguinte formato: ID>/task/<taskId> Nota: Use a API Listar Tarefas para obter o ID da tarefa. Faça a seguinte solicitação HTTP PUT para a URL de Atualizar Tarefa para atualizar a tarefa completa: PUT ID>/task/<taskId> Faça a seguinte solicitação HTTP PATCH para a URL de Atualizar Tarefa para atualizar alguns campos de tarefa: PATCH ID>/task/<taskId> Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: PUT ID>/task/<taskId> Content-Type: application/<json/xml> 70 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

71 Corpo da Solicitação Use a API Ler Tarefa para obter os detalhes da tarefa. Especifique os atributos da tarefa ao atualizar a tarefa. Use o formato JSON ou XML para enviar os dados a serem atualizados na solicitação. A seguinte tabela descreve os parâmetros de tarefas no corpo da solicitação: Parâmetro tasktype taskid owner title comments duedate status priority creator createdate updatedby lastupdatedate orsid processid taskrecord businessentity name Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Use o atributo name para especificar o tipo de tarefa. Para obter mais informações sobre tipos de tarefas, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. O ID da tarefa. O usuário que realiza a tarefa. Descrição resumida da tarefa. Comentários para a tarefa. Data na qual o proprietário deve concluir a tarefa. Use o formato ISO 8601: para especificar a data. Status da tarefa no fluxo de trabalho. Use um destes dois valores: - Open: a tarefa não foi iniciada ou está em andamento. - Closed: a tarefa está concluída ou foi cancelada. Nível de importância da tarefa. Use um dos seguintes valores: high, normal e low. O padrão é normal. Usuário que cria a tarefa. Data em que a tarefa foi criada. Use o formato ISO 8601: para especificar a data. Usuário que atualiza a tarefa. Data da última atualização da tarefa. Use o formato ISO 8601: NOTE-datetime para especificar a data. O ID do ORS registrado na ferramenta Bancos de Dados do Console do Hub. O ID do processo de fluxo de trabalho que contém essa tarefa. O registro raiz da entidade comercial ou o registro de referência cruzada associado à tarefa. Use o ID de linha ou o sistema de origem e a chave de origem para especificar o registro. Nome da entidade comercial à qual taskrecord pertence. O seguinte código de amostra usa rowid para especificar taskrecord: taskrecord: [ businessentity: name: 'Person', key: Referência de API REST para Serviços de Entidade Comercial 71

72 ] rowid: '233', systemname: '', sourcekey: '' Para uma solicitação PATCH, o corpo da solicitação contém os campos de tarefa que você deseja alterar. É possível alterar o título, a prioridade, a data de vencimento e o proprietário da tarefa. Para uma solicitação PUT, o corpo da solicitação contém todos os campos de tarefa. Use o seguinte corpo de solicitação para uma solicitação PUT: tasktype: name:"name of the task", taskid: "ID of the task", owner: "user who performs the task", title: "title of the task", comments: "description of the task", duedate: "date to complete the task", status: "status of the task", priority: "priority of the task", creator: "use who creates the task", createdate: "date on which the task is created", updatedby: "user who last updated the task", lastupdatedate: "date on which the task was last updated", businessentity: "name of the business entity", orsid: "database ID", processid: 'ActiveVOS task type ID', taskrecord: [ businessentity: name: 'name of the business entity', key: rowid: 'rowid of the record',//use the rowid or the source system and source key to identify the record. systemname: '', sourcekey: '' ] Solicitação de API de Amostra A seguinte solicitação PUT de amostra atualiza uma tarefa concluída: PUT tasktype: name:"updatewithapprovalworkflow", taskid: "urn:b4p2:15934", owner: "John", title: "Smoke test task - updated", comments: "Smoke testing - updated", duedate: " T00:00:00", status: "OPEN", priority: "HIGH", creator: "admin", createdate: " T00:00:00", updatedby: "admin", lastupdatedate: " T00:00:00", businessentity: "Person", orsid: "localhost-orcl-ds_ui1", processid: '3719', taskrecord: [ businessentity: name: 'Person', key: 72 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

73 ] rowid: '123', systemname: '', sourcekey: '' A seguinte solicitação PATCH de amostra atualiza alguns campos de tarefa: PATCH processid: "3719", priority: "HIGH", owner: "John" Resposta de API de Amostra A API retorna um código de resposta OK 200 ao atualizar uma tarefa com êxito. O corpo da resposta está vazio. Tarefa Concluída A API REST de Tarefa Concluída fecha um fluxo de trabalho de tarefa após a conclusão de todas as tarefas do fluxo de trabalho. Use a API para fechar um fluxo de trabalho depois de processar todos os registros de entidade comercial relacionados à tarefa. Por exemplo, quando você seleciona candidatos a mesclagem, pode criar uma tarefa que inicia o fluxo de trabalho de mesclagem. A tarefa de mesclagem é concluída depois que você visualiza cada candidato e mescla ou marca esse candidato como não sendo uma correspondência. Use a API para fechar o fluxo de trabalho de mesclagem. A API usa o método PUT. URL da Solicitação A URL de Tarefa Concluída tem o seguinte formato: ID>/task/<taskId>?action=complete Faça a seguinte solicitação HTTP PUT para a URL de Tarefa Concluída: PUT ID>/task/<taskId>?action=complete Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: PUT ID>/task/<taskId>?action=complete Content-Type: application/<json/xml> Referência de API REST para Serviços de Entidade Comercial 73

74 Corpo da Solicitação Envie os detalhes da tarefa no corpo da solicitação. Use a API Ler Tarefa para obter os detalhes da tarefa. A seguinte tabela descreve os parâmetros de tarefas no corpo da solicitação: Parâmetro tasktype taskid owner title comments duedate status priority creator createdate updatedby lastupdatedate orsid processid taskrecord businessentity name Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Use o atributo name para especificar o tipo de tarefa. Para obter mais informações sobre tipos de tarefas, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. O ID da tarefa. O usuário que realiza a tarefa. Descrição resumida da tarefa. Comentários para a tarefa. Data na qual o proprietário deve concluir a tarefa. Use o formato ISO 8601: para especificar a data. Status da tarefa no fluxo de trabalho. Use um destes dois valores: - Open: a tarefa não foi iniciada ou está em andamento. - Closed: a tarefa está concluída ou foi cancelada. Nível de importância da tarefa. Usuário que cria a tarefa. Data em que a tarefa foi criada. Use o formato ISO 8601: para especificar a data. Usuário que atualiza a tarefa. Data da última atualização da tarefa. Use o formato ISO 8601: NOTE-datetime para especificar a data. O ID do ORS registrado na ferramenta Bancos de Dados do Console do Hub. O ID do processo de fluxo de trabalho que contém essa tarefa. O registro raiz da entidade comercial ou o registro de referência cruzada associado à tarefa. Use o ID de linha ou o sistema de origem e a chave de origem para especificar o registro. Nome da entidade comercial à qual taskrecord pertence. O seguinte código de amostra usa rowid para especificar taskrecord: taskrecord: [ businessentity: name: 'Person', key: rowid: '233', systemname: '', sourcekey: '' 74 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

75 ] Solicitação de API de Amostra A seguinte solicitação de amostra conclui o fluxo de trabalho de mesclagem: PUT action=complete "tasktype": "name":"merge", "taskid": "urn:b4p2:20210", "owner": "admin", "duedate": " T17:00:00-07:00", "status": "OPEN", "priority": "NORMAL", "creator": "admin", "createdate": " T00:00:00", "updatedby": "admin", "lastupdatedate": " T00:00:00", "businessentity": "Person", "orsid": "localhost-orcl-ds_ui1", "processid": "20208", "taskrecord": [ "businessentity": "name": "Person", "key": "rowid": "233", "systemname": "", "sourcekey": "" ] Resposta de API de Amostra A API retorna uma resposta OK 200 ao concluir um fluxo de trabalho de tarefa com êxito. O corpo da resposta está vazio. Executar Ação de Tarefa A API REST Executar Ação de Tarefa define uma tarefa de volta ao fluxo de trabalho para processamento posterior. Cada tipo de tarefa tem um conjunto de ações de tarefas e um fluxo de trabalho que especifica a sequência de tarefas. Quando você executa uma ação de tarefa, a tarefa se move para a próxima etapa do fluxo de trabalho. Se uma ação de tarefa não tiver uma tarefa subsequente, o fluxo de trabalho terminará quando você executar essa ação. A API usa o método POST para realizar ações, como aprovar, escalar ou cancelar uma tarefa. URL da Solicitação O seguinte URL especifica o formato da URL de Executar Ação de Tarefa: ID>/task/<taskId>?action=<taskAction> Nota: Use a API Listar Tarefas para obter o ID da tarefa. Faça a seguinte solicitação HTTP POST para a URL de Executar Ação de Tarefa: POST ID>/task/<taskId>?action=<taskAction> Referência de API REST para Serviços de Entidade Comercial 75

76 Se quiser editar a tarefa antes de executar a ação de tarefa, adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados da solicitação: POST ID>/task/<taskId>?action=<taskAction> Content-Type: application/<json/xml> Corpo da Solicitação Forneça os dados da tarefa no corpo da solicitação se quiser alterar os detalhes dessa tarefa antes de executar a ação de tarefa. A seguinte tabela descreve os parâmetros no corpo da solicitação: Parâmetro tasktype taskid owner title comments duedate status priority creator createdate updatedby lastupdatedate businessentity orsid processid Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Use o atributo name para especificar o tipo de tarefa. Para obter mais informações sobre tipos de tarefas, consulte o Guia de Implementação do Informatica Data Director do Informatica MDM Multidomain Edition. O ID da tarefa. O usuário que realiza a tarefa. Descrição resumida da tarefa. Comentários para a tarefa. Data na qual o proprietário deve concluir a tarefa. Use o formato ISO 8601: para especificar a data. Status da tarefa no fluxo de trabalho. Use um destes dois valores: - Open: a tarefa não foi iniciada ou está em andamento. - Closed: a tarefa está concluída ou foi cancelada. Nível de importância da tarefa. Use um dos seguintes valores: high, normal e low. Usuário que cria a tarefa. Data em que a tarefa foi criada. Use o formato ISO 8601: para especificar a data. Usuário que atualiza a tarefa. Data da última atualização da tarefa. Use o formato ISO 8601: NOTE-datetime para especificar a data. Nome da entidade comercial. O ID do ORS registrado na ferramenta Bancos de Dados do Console do Hub. O ID do processo de fluxo de trabalho que contém essa tarefa. 76 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

77 Parâmetro taskrecord businessentity name Descrição O registro raiz da entidade comercial ou o registro de referência cruzada associado à tarefa. Use o ID de linha ou o sistema de origem e a chave de origem para especificar o registro. Nome da entidade comercial à qual taskrecord pertence. O seguinte código de amostra usa rowid para especificar taskrecord: taskrecord: [ businessentity: name: 'Person', key: rowid: '233', systemname: '', sourcekey: '' ] Solicitação de API de Amostra A seguinte solicitação de amostra cancela uma tarefa e encerra o fluxo de trabalho: POST taskaction=cancel tasktype: name:"updatewithapprovalworkflow", taskaction: [name: "Cancel"], taskid: "urn:b4p2:15934", owner: "manager", title: "Smoke test task 222", comments: "Smoke testing", duedate: " T00:00:00", status: "OPEN", priority: "NORMAL", creator: "admin", createdate: " T00:00:00", updatedby: "admin", lastupdatedate: " T00:00:00", businessentity: "Person", orsid: "localhost-orcl-ds_ui1", processid: '3685', taskrecord: [ businessentity: name: 'Person', key: rowid: '123', systemname: '', sourcekey: '' ] Resposta de API de Amostra A API retorna um código de resposta OK 200 ao executar uma ação de tarefa com êxito. O corpo da resposta está vazio. Referência de API REST para Serviços de Entidade Comercial 77

78 Listar Usuários Atribuíveis A API REST Listar Usuários Atribuíveis retorna uma lista de usuários aos quais você pode atribuir as tarefas que pertencem a um tipo de tarefa. Use a API para obter os usuários de destino para uma tarefa. A API usa o método GET. URL da Solicitação A URL de Listar Usuários Atribuíveis tem o seguinte formato: ID>/user?taskType=<task type>&businessentity=<business entity name> Faça a seguinte solicitação HTTP GET para a URL de Listar Usuários Atribuíveis: GET ID>/user?taskType=<task type>&businessentity=<business entity name> Parâmetros de Consulta A seguinte tabela lista os parâmetros necessários na URL: Parâmetro tasktype businessentity Descrição Um conjunto de ações que você pode realizar em um registro de entidade comercial. Os tipos de tarefas incluem atualizar com aprovação, atualizar com aprovação opcional, mesclar, desfazer mesclagem, revisar sem aprovação, fazer revisão final e atualizar registro rejeitado. Nome da entidade comercial. Solicitação de API de Amostra A seguinte solicitação de amostra recupera uma lista de usuários atribuíveis: GET tasktype=reviewnoapprove&businessentity=person Resposta de API de Amostra A seguinte resposta de amostra exibe a lista de usuários atribuíveis para o tipo de tarefa ReviewNoApprove: "users": "user": [ "username": "admin" ], "roles": Visualizar Promoção A API REST Visualizar Promoção retorna uma visualização de um registro de entidade comercial resultante quando você promove as alterações pendentes. A API usa o método GET. Você pode ver a aparência de um registro se aplicar a ele as alterações pendentes. A resposta da API contém o registro com os novos valores e um resumo de alterações com os 78 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

79 valores antigos. A API não retorna informações sobre os dados que você exclui. Forneça o ID de interação das alterações pendentes na URL. URL da Solicitação A URL de Visualizar Promoção tem o seguinte formato: ID><business entity>/<rowid>? action=previewpromote&interactionid=<interaction ID> Faça a seguinte solicitação HTTP GET para a URL de Visualizar Promoção: GET ID><business entity>/<rowid>? action=previewpromote&interactionid=<interaction ID> Parâmetros de Consulta O ID de interação das alterações pendentes é um parâmetro necessário na URL. A seguinte tabela lista os parâmetros de consulta: Parâmetro interactionid effectivedate Descrição O ID de interação das alterações pendentes. Opcional. Data para a qual você deseja visualizar as alterações. Use o parâmetro para objetos base ativados para linha do tempo. Solicitação de API de Amostra A seguinte solicitação de amostra cria uma visualização de um registro raiz na entidade comercial Person: GET action=previewpromote&interactionid= Resposta de API de Amostra A seguinte resposta de amostra retorna uma visualização do registro com os novos valores e um resumo de alterações de valores antigos: "rowidobject": "233 ", "creator": "admin", "createdate": " T02:15:02-07:00", "updatedby": "admin", "lastupdatedate": " T03:42: :00", "consolidationind": "1", "lastrowidsystem": "SYS0 ", "dirtyindicator": "0", "interactionid": " ", "hubstateind": "1", "label": "LLOYD,BOB", "partytype": "Person", "lastname": "LLOYD", "firstname": "BOB", "displayname": "BOB LLOYD", "preferredphone": "rowidobject": "164 ", "$original": "rowidobject": "164 ", "$original": Referência de API REST para Serviços de Entidade Comercial 79

80 "label": "DUNN,LLOYD", "lastname": "DUNN", "firstname": "LLOYD", "displayname": "LLOYD DUNN" Promover A API REST Promover promove todas as alterações pendentes feitas em um registro de entidade comercial com base no ID de interação da solicitação de alteração. A API usa o método POST. Forneça o ID de interação como um parâmetro de consulta. URL da Solicitação A URL de Promover tem o seguinte formato: ID>/<business entity>/<rowid of the business entity root record>?action=promote&interactionid=<interaction ID> Faça a seguinte solicitação HTTP POST para a URL de Promover: POST ID>/<business entity>/<rowid of the business entity root record>?action=promote&interactionid=<interaction ID> Parâmetro de Consulta O ID de interação das alterações pendentes é um parâmetro necessário. A API usa o ID de interação para localizar todos os registos relacionados às alterações pendentes. Solicitação de API de Amostra A seguinte solicitação de amostra promove todas as alterações pendentes com base no ID de interação da solicitação de alteração: POST action=promote&interactionid= Resposta de API de Amostra A seguinte resposta de amostra contém o ID de linha do registro após a promoção das alterações pendentes: Person: rowidobject: " " Excluir Pendentes A API REST Excluir Pendentes exclui todas as alterações pendentes feitas em um registro de entidade comercial com base no ID de interação da solicitação de alteração. A API usa o método DELETE e retorna o ID de linha do registro. 80 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

81 URL da Solicitação A URL de Excluir Pendentes tem o seguinte formato: ID>/<business entity>/<rowid>? action=deletepending&interactionid=<interaction ID> Faça a seguinte solicitação DELETE para a URL de Excluir Pendentes: DELETE ID>/<business entity>/<rowid>? action=deletepending&interactionid=<interaction ID> Parâmetro de Consulta Forneça o ID de interação das alterações pendentes que você deseja excluir. Solicitação de API de Amostra A seguinte solicitação de amostra exclui todas as alterações pendentes com base no ID de interação da solicitação de alteração: DELETE action=deletepending&interactionid= Resposta de API de Amostra A seguinte resposta de amostra contém o ID de linha do registro após a exclusão das alterações pendentes: Person: rowidobject: "233" Visualizar Mesclagem A API REST Visualizar Mesclagem retorna uma visualização de um registro raiz de entidade comercial consolidado quando dois ou mais registros raiz são mesclados. A API usa o método POST e aceita uma lista de registros raiz e substituições em nível de campo para retornar uma visualização do registro mesclado. O ID de linha do registro de destino é um parâmetro necessário. URL da Solicitação A URL de Visualizar Mesclagem tem o seguinte formato: ID>/<business entity>/<rowid of the business entity record>?action=previewmerge O seguinte formato da URL de Visualizar Mesclagem especifica o número de níveis filho a serem retornados: ID>/<business entity>/<rowid of the business entity record>?action=previewmerge&depth=2 Faça a seguinte solicitação HTTP POST para a URL de Visualizar Mesclagem: POST ID>/<business entity>/<rowid of the business entity record>?action=previewmerge Referência de API REST para Serviços de Entidade Comercial 81

82 Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: POST ID>/<business entity>/<rowid of the business entity record>?action=previewmerge Content-Type: application/<json/xml> Parâmetros de Consulta O ID de linha do registro de destino é um parâmetro necessário. É possível usar os seguintes parâmetros de consulta: Parâmetro depth effectivedate Descrição Número de níveis filho a serem retornados. Data para a qual você deseja gerar a visualização. Corpo da Solicitação Use a API Ler Registros Correspondidos para determinar quais registros você pode mesclar com o registro raiz original. Envie a lista de registros no corpo da solicitação. Use o ID de linha ou o sistema de origem e a chave de origem para especificar os registros que você deseja mesclar. Especifique as substituições em nível de campo para o registro mesclado no corpo da solicitação. O seguinte exemplo mostra um corpo de solicitação para a API Visualizar Mesclagem: keys: [ systemname: "SFA"' sourcekey: " ", rowid: " " ], overrides: Person: firstname: "John", //override lastname: "Alexander" //override Solicitação de API de Amostra A seguinte solicitação de amostra retorna a visualização de um registro consolidado: POST action=previewmerge keys: [ rowid: " ", rowid: " " ], overrides: Person: firstname: "Charlie" 82 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

83 Resposta de API de Amostra A seguinte resposta de amostra exibe a visualização do registro consolidado: "Person": "rowidobject": " ", "partytype": "Person", "lastname": "Smith", "firstname": "Charlie", "displayname": "ALICE SMITH" Mesclar Registros A API REST Mesclar Registros mescla dois ou mais registros raiz para criar um único registro consolidado. O ID de linha do registro consolidado é o ID de linha do registro ao qual os outros registros são mesclados. A API usa o método POST. É possível especificar substituições em nível de campo para o registro mesclado no corpo da solicitação. URL da Solicitação A URL de Mesclar Registros tem o seguinte formato: ID>/<business entity>/<rowid of the business entity record>?action=merge Faça a seguinte solicitação HTTP POST para a URL de Mesclar Registros: POST ID>/<business entity>/<rowid of the business entity record>?action=merge Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: POST ID>/<business entity>/<rowid of the business entity record>?action=merge Content-Type: application/<json/xml> Corpo da Solicitação Envie a lista dos registros a serem mesclados no corpo da solicitação. Use o ID de linha ou o sistema de origem e a chave de origem para especificar os registros. Especifique as substituições em nível de campo para o registro mesclado no corpo da solicitação. Use a API Obter Registros Correspondidos para determinar quais registros você pode mesclar com o registro raiz original. O seguinte exemplo mostra um corpo de solicitação com IDs de linha e substituições: keys: [ rowid: " ", rowid: " " ], overrides: Person: Referência de API REST para Serviços de Entidade Comercial 83

84 firstname: "Charlie" Solicitação de API de Amostra A seguinte solicitação de exemplo mescla registros para formar um registro consolidado: POST Content-Type: application/<json/xml> keys: [ rowid: " " ], overrides: Person: firstname: "Charlie" Resposta de API de Amostra A seguinte resposta de amostra exibe o registro consolidado: "Person": "link": [ "href": " ", "rel": "self" ], "key": "rowid": " ", "rowidobject": " " Reverter a Mesclagem de Registros A API REST Reverter a Mesclagem de Registros reverte a mesclagem de registro raiz nos registros raiz individuais que existiam antes da mesclagem dos registros. A API usa o método POST. URL da Solicitação A URL de Reverter a Mesclagem de Registros tem o seguinte formato: ID>/<business entity>/<rowid>?action=unmerge Faça a seguinte solicitação HTTP POST para a URL de Reverter a Mesclagem de Registros: POST ID>/<business entity>/<rowid>? action=unmerge 84 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

85 Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: POST ID>/<business entity>/<rowid>? action=unmerge Content-Type: application/<json/xml> Corpo da Solicitação Envie a lista dos registros cuja mesclagem você deseja reverter no registro consolidado do corpo da solicitação. Use o ID de linha xref ou o sistema de origem e a chave de origem para especificar os registros. Use a API Ler Entidade Comercial para obter o xref rowid do registro cuja mesclagem deve ser revertida. A seguinte solicitação de amostra recupera os metadados XREF de um registro de entidade comercial: GET contentmetadata=xref Solicitação de API de Amostra A seguinte solicitação de amostra reverte a mesclagem de um registro consolidado: POST rowid: " " Resposta de API de Amostra A seguinte resposta de amostra exibe o registro cuja mesclagem é revertida do registro consolidado: "Person": "link": [ "href": " ", "rel": "self" ], "key": "rowid": " ", "rowidobject": " " Obter Registos Relacionados A API REST Obter Registos Relacionados retorna uma lista de registros relacionados a um registro raiz especificado com base nos relacionamentos que você configura no Gerenciador de Hierarquia. A API também retorna os detalhes dos relacionamentos do Gerenciador de Hierarquia. Nos resultados, o número de registos relatados em recordcount pode ser menor que o número de entidades relacionadas retornadas. O valor de recordcount é o número de entidades com IDs de linha distintos. As entidades relacionadas retornadas incluem entidades de diferentes tipos que têm o mesmo ID de linha. Por exemplo, um esquema pode ter os tipos de entidade comercial Person e SecurePerson que usam o mesmo objeto base C_PARTY, o que significa que eles possuem o mesmo ID de linha. No entanto, como uma entidade comercial pode ser usada para representar a entidade Person do Gerenciador de Hierarquia, ambos são retornados pela API Obter Registos Relacionados. Portanto, nos seus resultados, você vê Referência de API REST para Serviços de Entidade Comercial 85

86 recordcount=1 seguido por duas entradas <relatedentity>. Essas entradas têm valores diferentes para xsi:type, mas o mesmo valor para rowidojbect. A API usa o método GET. URL da Solicitação A URL de Obter Registos Relacionados tem o seguinte formato: ID>/<business entity>/<rowid>?action=related Faça a seguinte solicitação HTTP GET para a URL de Obter Registos Relacionados: GET ID>/<business entity>/<rowid>? action=related Corpo da Resposta O corpo da resposta contém a lista de registros relacionados, informações sobre os registros relacionados e os relacionamentos, bem como um token de pesquisa. Use o token de pesquisa para buscar as páginas subsequentes do resultado. Solicitação de API de Amostra A seguinte solicitação de amostra busca os registros relacionados e os relacionamentos configurados para uma entidade comercial: GET Resposta de API de Amostra A seguinte resposta de amostra exibe os registros relacionados e os relacionamentos definidos no Gerenciador de Hierarquia: "firstrecord": 1, "recordcount": 1, "pagesize": 10, "searchtoken": "SVR1.AU5I4", "relatedentity": [ "businessentity": "Person": "link": [ "href": " Person/ ", "rel": "self" ], "rowidobject": " ", "hubstateind": "1", "partytype": "Person", "lastname": "Smith", "firstname": "Bob", "entitylabel": " Bob Smith ", "relationshiplabel": "Relative", "businessentity": "SecurePerson": "link": [ 86 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

87 "href": " SecurePerson/ ", "rel": "self" ], "rowidobject": " ", "hubstateind": "1", "partytype": "Person", "lastname": "Smith", "firstname": "Bob", "entitylabel": " Bob Smith ", "relationshiplabel": "Relative" ] Ler Registros Correspondidos A API REST Ler Registros Correspondidos retorna registros que correspondem a um registro raiz especificado. É possível rever a lista de registros para determinar quais deles podem ser mesclados com o registro raiz original. É possível usar a API Mesclar Registros para mesclar os registros. A API usa o método GET. URL da Solicitação A URL de Ler Registros Correspondidos tem o seguinte formato: ID>/<business entity>/<rowid>?action=matched Faça a seguinte solicitação HTTP GET para a URL de Ler Registros Correspondidos: GET ID>/<business entity>/<rowid>? action=matched Corpo da Resposta O corpo da resposta contém o número de registros que correspondem ao registro especificado, os detalhes dos registros correspondentes e um token de pesquisa. Use o token de pesquisa para buscar as páginas subsequentes do resultado da correspondência. Solicitação de API de Amostra A seguinte solicitação de amostra pesquisa a entidade comercial em busca de registros que correspondem a um registro: GET Resposta de API de Amostra A seguinte resposta de amostra exibe os detalhes do registro que corresponde ao registro especificado: "firstrecord": 1, "recordcount": 1, "pagesize": 10, "searchtoken": "SVR1.AU5HE", "matchedentity": [ "businessentity": "Person": Referência de API REST para Serviços de Entidade Comercial 87

88 Person/ ", ] "link": [ "href": " "rel": "self" ], "rowidobject": " ", "creator": "admin", "createdate": " T02:15:02-07:00", "updatedby": "Admin", "lastupdatedate": " T02:59:17-07:00", "consolidationind": "1", "lastrowidsystem": "SFA ", "dirtyindicator": "0", "hubstateind": "1", "partytype": "Person", "lastname": "BATES", "firstname": "DAISY", "displayname": "DAISY BATES", "matchrule": "DELETED: PUT " Atualizar Registros Correspondidos A API REST Atualizar Registros Correspondidos cria ou atualiza um registro na tabela de correspondências. A tabela de correspondências contém os pares de registros correspondidos em uma entidade comercial depois que você executa um processo de correspondência na entidade comercial. Use a API para adicionar registros que se qualificam para uma mesclagem com o registro especificado. A API usa o método PUT. URL da Solicitação A URL de Atualizar Registros Correspondidos tem o seguinte formato: ID>/<business entity>/<rowid>?action=matched Faça a seguinte solicitação HTTP PUT para a URL de Atualizar Registros Correspondidos: ID>/<business entity>/<rowid>?action=matched Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: ID>/<business entity>/<rowid>?action=matched Content-Type: application/<json/xml> Corpo da Solicitação Envie a lista de registros que correspondem ao registro especificado no corpo da solicitação. Use o ID de linha ou o sistema de origem e a chave de origem para especificar os registros. 88 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

89 Solicitação de API de Amostra A seguinte amostra adiciona um registro na tabela de correspondências: PUT keys: [ rowid: " " ] Resposta de API de Amostra A API retorna uma resposta OK 200 ao criar um registro na tabela de correspondências com êxito. O corpo da resposta está vazio. Excluir Registros Correspondidos A API REST Excluir Registros Correspondidos exclui registros correspondidos associados a um registro raiz da tabela de correspondências. A API usa o método DELETE. URL da Solicitação A URL de Excluir Registros Correspondidos tem o seguinte formato: ID>/<business entity>/<rowid>?action=matched Faça a seguinte solicitação HTTP DELETE para a URL de Excluir Registros Correspondidos: DELETE ID>/<business entity>/<rowid>? action=matched Adicione o cabeçalho Content-Type para especificar o tipo de mídia dos dados que você deseja enviar com a solicitação: DELETE ID>/<business entity>/<rowid>? action=matched Content-Type: application/<json/xml> Corpo da Solicitação Envie a lista de registros que você deseja excluir da tabela de correspondências no corpo da solicitação. Solicitação de API de Amostra A seguinte solicitação de amostra exclui um registro que corresponde ao registro raiz especificado na tabela de correspondências: DELETE keys: [ rowid: " " ] Referência de API REST para Serviços de Entidade Comercial 89

90 Resposta de API de Amostra A API retorna uma resposta OK 200 ao excluir um registro da tabela de correspondências com êxito. O corpo da resposta está vazio. 90 Capítulo 3: Chamadas de Serviços de Entidade Comercial Representational State Transfer

91 C A P Í T U L O 4 Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol Este capítulo inclui os seguintes tópicos: Chamadas Simple Object Access Protocol para Serviços de Entidade Comercial, 91 Método de autenticação, 92 Cookies de Autenticação para Logon de Aplicativos de Terceiros, 92 Arquivo WSDL (Web Services Description Language), 93 URL SOAP, 94 Solicitações e Respostas SOAP, 95 Visualizando Parâmetros de Entrada e Saída, 96 Referência de API SOAP, 97 Solicitação e Resposta SOAP de Amostra, 98 Chamadas Simple Object Access Protocol para Serviços de Entidade Comercial Chamadas de ponto de extremidade SOAP (Simple Object Access Protocol) disponibilizam todos os serviços de entidade comercial como serviços da Web. É possível fazer chamadas SOAP para criar, excluir, atualizar e procurar registros em uma entidade comercial. Você pode realizar operações, como mesclar, cancelar mesclagens e corresponder registros. Você também pode fazer chamadas SOAP para criar, atualizar, procurar e realizar tarefas. Os pontos de extremidade SOAP para serviços de entidade comercial usam o UsernameToken WS-Security (Web Services Security) para autenticar usuários. Nota: Antes de usar as APIs SOAP para chamar os serviços de entidade comercial, valide o Armazenamento de Referências Operacionais. 91

92 Método de autenticação Todas as chamadas SOAP para os serviços de entidade comercial exigem a autenticação do usuário. Forneça o nome de usuário e a senha no cabeçalho da mensagem SOAP da solicitação de serviço da Web. O elemento Security do cabeçalho SOAP contém dados relacionados a segurança. O elemento Security contém o elemento UsernameToken, que tem os seguintes elementos filho: username password Nome do usuário associados ao token. A senha do nome de usuário associado ao token. Envie o nome de usuário e a senha no elemento UsernameToken. O exemplo a seguir mostra o elemento de cabeçalho Security na mensagem SOAP: <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:cs-ors.informatica.mdm"> <soapenv:header> <Security xmlns=" <UsernameToken> <Username>admin</Username> <Password>admin</Password> </UsernameToken> </Security> </soapenv:header> <soapenv:body>... </soapenv:body> </soapenv:envelope> Cookies de Autenticação para Logon de Aplicativos de Terceiros Use cookies de autenticação para autenticar os usuários do MDM Hub e chamar os serviços de entidade comercial de aplicativos de terceiros. É possível obter um cookie com base nas credenciais de um usuário autenticado. Salve o cookie e use-o para chamar as APIs SOAP. Não é necessário inserir o nome de usuário e a senha em código fixo. Realize a seguinte solicitação POST para fazer logon na Exibição do Entity 360 com seu nome de usuário e sua senha: POST user: 'admin', password: 'user password' Quando a operação de logon for bem-sucedida, o servidor retornará o cookie de autenticação no campo de cabeçalho set-cookie. O seguinte código de amostra apresenta um set-cookie no cabeçalho de resposta: Set-Cookie: auth_hash_cookie="admin===qtc1rkngqkncmzc1rjiyoq=="; Version=1; Path=/ Armazene o hash e use-o no cabeçalho de solicitação das suas chamadas de API. Não é necessário fornecer um nome de usuário e uma senha para as chamadas de API. 92 Capítulo 4: Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol

93 O seguinte exemplo mostra como usar um cookie de autenticação no seu cabeçalho de solicitação de API: GET of host>/cmx/cs/localhost-orcl-ds_ui1 Cookie: auth_hash_cookie="admin===qtc1rkngqkncmzc1rjiyoq==" Arquivo WSDL (Web Services Description Language) Arquivos WSDL (Web Services Description Language) contêm as descrições XML dos serviços Web, os formatos das solicitações e respostas SOAP e todos os parâmetros. O MDM Hub gera um arquivo WSDL para cada Armazenamento de Referências Operacionais. Os arquivos WSDL para cada Armazenamento de Referências Operacionais estão na seguinte localização: Arquivo WSDL (Web Services Description Language) 93

94 A seguinte imagem mostra a localização onde você pode baixar o arquivo WSDL para os Armazenamentos de Referências Operacionais: Clique no link para baixar o arquivo WSDL para o Armazenamento de Referências Operacionais DS_UI1 ou DS_UI2. URL SOAP Uma URL SOAP é o endereço que você usa para se conectar ao servidor SOAP. Uma URL SOAP tem a seguinte sintaxe: ID> 94 Capítulo 4: Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol

95 A URL tem os seguintes campos: host porta contexto O host que executa o banco de dados. Número de porta usado pelo ouvinte do banco de dados. O contexto é sempre cmx/services/beservices. ID do banco de dados O ID do ORS registrado na ferramenta Bancos de Dados do Console do Hub. O seguinte exemplo mostra um URL SOAP: Solicitações e Respostas SOAP Use o formato de mensagem XML SOAP para enviar solicitações via cliente SOAP ao serviço de entidade comercial e para receber respostas desse serviço para o cliente. A solicitação SOAP e o formato da resposta são os mesmos. Uma mensagem SOAP contém os seguintes elementos: Envelope Define o início e o fiim da mensagem. Cabeçalho Corpo Opcional. Contém atributos adicionais, como detalhes de autenticação para processar a mensagem. Se o elemento Header estiver presente, ele deverá ser o primeiro elemento filho do elemento Envelope. Contém os dados XML que são processados pelo cliente ou pelo serviço da Web. Uma mensagem SOAP tem o seguinte formato: <?xml version="1.0"?> <env:envelope xmlns:env=" > <env:header> </env:header> <env:body> </env:body> </env:envelope> Uma solicitação SOAP tem o seguinte formato: POST /<host>:<port>/<context>/<database ID> HTTP/1.0 Content-Type: text/xml; charset=utf-8 <?xml version="1.0"?> <env:envelope xmlns:env=" > <env:header> </env:header> <env:body> Solicitações e Respostas SOAP 95

96 </env:body> </env:envelope> Uma resposta SOAP tem o seguinte formato: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0"?> <env:envelope xmlns:env=" > <env:header> </env:header> <env:body> </env:body> </env:envelope> Visualizando Parâmetros de Entrada e Saída Você pode usar uma ferramenta de testes funcionais, como a SoapUI, para visualizar os parâmetros de entrada e saída da API SOAP. Crie um projeto SOAP e importe o arquivo WSDL para esse projeto. As operações que você pode realizar usando os serviços de entidade comercial aparecem como nós na SoapUI. Cada operação tem uma solicitação e um formato de mensagem de resposta. A SoapUI cria uma solicitação de amostra para cada operação quando você importa o arquivo WSDL. Abra o projeto e clique duas vezes em uma solicitação para abrir o editor de solicitações. A seguinte imagem mostra os parâmetros de entrada na SoapUI para a API SOAP WritePerson: 96 Capítulo 4: Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol

97 Referência de API SOAP A referência de API SOAP para serviços de entidade comercial lista as APIs SOAP e fornece uma descrição para cada uma. Consulte também o arquivo WSDL para obter descrições de serviços de entidade comercial. Use as seguintes APIs SOAP para realizar operações em entidades comerciais: Obter Metadados Retorna a estrutura de dados de uma entidade comercial. Listar Entidade Comercial Retorna a lista de valores de pesquisa ou de valores de chave externa. Ler Entidade Comercial Retorna os detalhes de um registro raiz na entidade comercial. Criar Entidade Comercial Cria um registro na entidade comercial especificada. Atualizar Entidade Comercial Atualiza o registro raiz da entidade comercial especificada e seus registros filho. Excluir Entidade Comercial Exclui um registro raiz em uma entidade comercial. Pesquisar Entidade Comercial Pesquisa um valor de cadeia em uma entidade comercial raiz pesquisável e retorna os registros raiz que correspondem aos critérios de pesquisa. Visualizar Promoção Retorna uma visualização de um registro de entidade comercial resultante quando você promove alterações pendentes com base no ID de interação da solicitação de alteração. Promover Promove todas as alterações pendentes feitas em um registro de entidade comercial com base no ID de interação da solicitação de alteração. Excluir Promoção Exclui todas as alterações pendentes que você faz em um registro de entidade comercial com base no ID de interação da solicitação de alteração. Visualizar Mesclagem Retorna uma visualização de um registro raiz de entidade comercial consolidada quando dois ou mais registros raiz são mesclados. Mesclar Registros Mescla dois ou mais registros raiz para criar um único registro consolidado. Reverter a Mesclagem de Registros Reverte a mesclagem de um registro raiz em registros raiz individuais que existiam antes da mesclagem dos registros. Obter Registos Relacionados Retorna uma lista de registos relacionados com base nos relacionamentos que você configura no Gerenciador de Hierarquia. Referência de API SOAP 97

98 Ler Registros Correspondidos Retorna registros que correspondem a um registro raiz especificado. Atualizar Registros Correspondidos Cria ou atualiza um registro na tabela de correspondências. Excluir Registros Correspondidos Exclui registros correspondidos da tabela de correspondências. Obter Metadados do BPM Retorna os tipos de tarefas e dois indicadores que especificam se o adaptador de fluxo de trabalho pode executar o serviço Obter Linhagem de Tarefas e os serviços de administração. Listar Tarefas Ler Tarefa Retorna uma lista de tarefas de fluxo de trabalho. Retorna os detalhes de uma tarefa. Criar Tarefa Cria uma tarefa e inicia um fluxo de trabalho. Atualizar Tarefa Atualiza uma tarefa individual. Executar Ação de Tarefa Realiza uma ação de tarefa e define a tarefa de volta ao fluxo de trabalho para processamento posterior. Listar Usuários Atribuíveis Retorna uma lista de usuários aos quais você pode atribuir as tarefas que pertencem a um tipo de tarefa. Tarefa Concluída Fecha um fluxo de trabalho de tarefa após a conclusão de todas as tarefas do fluxo de trabalho. Solicitação e Resposta SOAP de Amostra A seguinte solicitação de amostra SOAP recupera uma lista de usuários atribuíveis: <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:cs-ors.informatica.mdm"> <soapenv:header> <Security xmlns=" <UsernameToken> <Username>admin</Username> <Password>admin</Password> </UsernameToken> </Security> </soapenv:header> <soapenv:body> <urn:listassignableusers> <!--Optional:--> <urn:parameters> <!--Optional:--> 98 Capítulo 4: Chamadas de Serviços de Entidade Comercial Simple Object Access Protocol

99 <urn:tasktype>update</urn:tasktype> <!--Optional:--> <urn:businessentity>person</urn:businessentity> </urn:parameters> </urn:listassignableusers> </soapenv:body> </soapenv:envelope> A seguinte resposta de amostra SOAP lista os usuários atribuíveis: <soapenv:envelope xmlns:soapenv=" xmlns:xsd=" xmlns:xsi=" XMLSchema-instance"> <soapenv:body> <ns6:listassignableusersreturn xmlns:ns1="urn:cs-base.informatica.mdm" xmlns:ns2="urn:co-base.informatica.mdm" xmlns:ns3="urn:co-ors.informatica.mdm" xmlns:ns4="urn:co-meta.informatica.mdm" xmlns:ns5="urn:task-base.informatica.mdm" xmlns:ns6="urn:cs-ors.informatica.mdm"> <ns6:object> <ns1:users> <user> <username>admin</username> </user> </users> <ns1:roles/> </ns6:object> </ns6:listassignableusersreturn> </soapenv:body> </soapenv:envelope> Solicitação e Resposta SOAP de Amostra 99

100 A P Ê N D I C E A Usando APIs REST para Adicionar Registros de Entidade Comercial Este apêndice inclui os seguintes tópicos: Usando APIs REST para Adicionar Registros de Entidade Comercial - Visão Geral, 100 Estrutura da Entidade Comercial Person, 101 Etapa 1. Obter Informações sobre o Esquema, 101 Etapa 2. Criar um Registro de Entidade Comercial, 107 Etapa 3. Ler o Registro de Entidade Comercial, 109 Usando APIs REST para Adicionar Registros de Entidade Comercial - Visão Geral Depois de criar um modelo de entidade comercial e configurar a estrutura da entidade comercial, você pode usar as APIs REST para adicionar os registros de entidade comercial. As seguintes seções usar o exemplo da entidade comercial Person para ilustrar como é possível adicionar registros usando APIs REST. A entidade comercial Person contém dados referentes aos funcionários na sua empresa. Use as seguintes APIs para adicionar os detalhes dos seus funcionários: 1. Obtenha informações sobre o esquema. Use a API REST Obter Metadados para obter informações sobre a estrutura de dados de uma entidade comercial, incluindo a estrutura, a lista de campos, os tipos de campos e os detalhes dos campos de pesquisa. Outra opção é acessar os arquivos XSD (XML Schema Definition) que descrevem quais elementos e atributos você pode usar. Os arquivos XSD estão na localização 2. Crie um registro de entidade comercial. Use a API REST Criar um Registro de Entidade Comercial para criar o registro. 3. Leia os dados do registro de entidade comercial que você adicionou. Use a API REST Ler Entidade Comercial para recuperar os dados do registro. 100

101 Estrutura da Entidade Comercial Person Adicionaremos um registro de Pessoa usando APIs REST. O nó raiz Pessoa é o nó superior na estrutura da entidade comercial Person. Abaixo do nó raiz Pessoa, existem nós referentes a detalhes de funcionários, como sexo, endereço e telefone. A seguinte imagem mostra a estrutura da entidade comercial Person: Pessoa é o nó raiz da entidade comercial Person. O tipo de nó, listado abaixo do nome do nó, indica o relacionamento entre o nó pai e o nó filho. Há um relacionamento de um-para-um entre o Endereço de Contato e o Endereço, o que indica que cada endereço de contato só pode ter um endereço associado a ele. Há um relacionamento de um-para-muitos entre Pessoa e Telefone, o que indica que um registro de Pessoa pode ter vários registros de número de telefone associados a ele. Há um relacionamento um-para-um entre Pessoa e Sexo, o que indica que um registro de pessoa pode ter somente um valor de sexo. Os valores de sexo residem em uma tabela de pesquisa. Da mesma forma, os valores de código de estado e código de país residem em tabelas de pesquisa. Etapa 1. Obter Informações sobre o Esquema Use a API REST Obter Metadados para obter informações sobre um esquema. A API Obter Metadados retorna a estrutura de dados de uma entidade comercial. Os metadados listam os campos da entidade comercial, os tipos de campo e os detalhes dos campos de pesquisa. A URL de Obter Metadados do tem o seguinte formato: ID>/<business entity>?action=meta A seguinte solicitação de amostra recupera informações de metadados para a entidade comercial Person: GET Estrutura da Entidade Comercial Person 101