Todos os produtos
Search

Este produto

    DataWorks:API do DataService Studio

    Central de documentação

    DataWorks:API do DataService Studio

    Última atualização: Jul 24, 2026

    O Data Map permite localizar APIs do DataService Studio em todos os workspaces do tenant atual, facilitando a descoberta eficiente.

    Página de pesquisa de API

    1. Acesse a página do Data Map.

      Faça login no console do DataWorks. Na região desejada, clique em Data Governance > Data Map no painel de navegação à esquerda. Na página exibida, clique em Go to Data Map.

    2. Acima da caixa de pesquisa, selecione a categoria API.

      O menu suspenso de tipo de pesquisa, à esquerda da barra de pesquisa, contém três grupos: Code, API e Dataset. Selecione API no grupo API.

    Localizar uma API

    1. Na caixa de pesquisa da categoria API, insira palavras-chave como API ID, APIPath, API Name ou API Description.

      Ao digitar uma palavra-chave, uma lista suspensa exibe as 10 principais APIs correspondentes.

    2. Se a API desejada não aparecer na lista suspensa, clique em Search para visualizar todas as correspondências.

    3. No painel à esquerda, filtre os resultados da pesquisa por API Type, Workspace ou Owner.

    4. Após encontrar a API de destino, clique nela para acessar a página de detalhes. Para mais informações, consulte View API details.

    Detalhes da API

    A página de detalhes da API apresenta as seções Basic Information, Technical Information, Parameter Information, Sample Response e Instructions. Se a API for do tipo Script Mode, a aba adicional Code também será exibida.

    A página de detalhes divide-se em três áreas: a Área ①, no topo, mostra o nome da API, a descrição e o ponto de entrada para edição; a Área ②, no painel esquerdo, exibe as informações básicas e técnicas; a Área ③, no painel direito, utiliza abas para apresentar conteúdos detalhados, como parâmetros, exemplos de resposta, linhagem de dados e notas de uso. A tabela a seguir descreve cada área.

    Área

    Description

    ①

    Clique em Edit API para abrir a janela de edição no workspace da API. Para mais informações, consulte API testing, publishing, and version management e Register an external API service.

    Nota

    Se sua conta não for membro do workspace da API, entre em contato com o proprietário do workspace e solicite a adição da sua conta como membro com a função Developer. Para mais informações, consulte Manage permissions on workspace-level services.

    ②

    Esta área exibe as seguintes informações da API:

    • Basic Information: Inclui detalhes como Views, Number of Calls, API ID, Workspace, Owner, Created At, Last Updated e Description.

    • Technical Information: Abrange especificações como API Type, Request Method, Response Type, Data Source Type, Data Source Name e Table Name.

    ③

    Esta área apresenta as seguintes informações:

    • Parameter Information: Exibe os Request Parameters e os Response Parameters da API.

      • Request Parameters: Contém detalhes sobre Common Request Parameters e API Request Parameters, incluindo Parameter Name, Parameter Type, Parameter Position, Sample Value, Default Value, Description e Label.

      • Response Parameters: Lista atributos dos Common Response Parameters e API Response Parameters, como Parameter Name, Parameter Type, Sample Value e Description.

    • Sample Response: Antes de publicar uma API, se você testá-la e selecionar Save the correct response example automatically durante o teste, o exemplo de resposta será atualizado com base nos resultados obtidos. Para mais informações, consulte Test an API. O conteúdo e a estrutura em Sample Response demonstram o formato de resposta da API.

    • Lineage Information: Apresenta a linhagem completa de dados entre tabelas, APIs e aplicativos. A linhagem de dados upstream para APIs do DataService Studio suporta os seguintes tipos de fonte de dados: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0 e AnalyticDB for PostgreSQL.

      Nota

      • Uma API Generation é criada pelo encapsulamento de uma fonte de dados ou tabela. Portanto, sua linhagem inclui tabelas de dados, a API e aplicativos.

      • Uma Register API é gerada ao encapsular um endereço de backend. Assim, sua linhagem compreende apenas a API e os aplicativos associados.

      • A linhagem de dados é gerada e atualizada em base T+1.

    • Instructions: Use esta seção para Edit as notas ou View Versions para revisar alterações históricas.

    • Code: Esta aba aparece somente quando a API é do tipo Script Mode. Ela permite visualizar o código de consulta personalizado (como SQL) escrito pelo desenvolvedor. A aba não é exibida para outros tipos de API (APIs em modo assistente, APIs registradas ou APIs de service orquestrado); para APIs em modo assistente, revise o SQL diretamente no editor de desenvolvimento da API do DataService.

      Nota

      Se você localizar uma API em modo script pesquisando por um trecho de código na caixa de pesquisa global do Data Map, o sistema acessará automaticamente a aba Code.