Todos los productos
Search

Este producto

    DataWorks:API de DataService Studio

    Centro de documentos

    DataWorks:API de DataService Studio

    Última actualización: Sep 04, 2026

    Data Map le permite buscar API de DataService Studio en todos los espacios de trabajo del tenant actual para facilitar su descubrimiento.

    Página de búsqueda de API

    1. Vaya a la página de Data Map.

      Inicie sesión en la consola de DataWorks. En la región deseada, haga clic en Data Governance > Data Map en el panel de navegación izquierdo. En la página que se muestra, haga clic en Go to Data Map.

    2. Encima del cuadro de búsqueda, seleccione la categoría API.

      El menú desplegable de tipo de búsqueda, ubicado a la izquierda de la barra de búsqueda, contiene tres grupos: Code, API y Dataset. Seleccione API en el grupo API.

    Buscar una API

    1. En el cuadro de búsqueda bajo la categoría API, introduzca palabras clave como API ID, APIPath, API Name o API Description.

      Al escribir una palabra clave, se muestra una lista desplegable con las 10 API principales que coinciden.

    2. Si la API deseada no aparece en la lista desplegable, haga clic en Search para ver todas las coincidencias.

    3. En el panel izquierdo, filtre los resultados de búsqueda por API Type, Workspace u Owner.

    4. Una vez localizada la API, haga clic en ella para ir a la página de detalles. Para obtener más información, consulte View API details.

    Detalles de la API

    La página de detalles de la API proporciona la Basic Information, la Technical Information, la Parameter Information, la Sample Response y las Instructions de la API. Si la API es de tipo Script Mode, también se muestra la pestaña adicional Code.

    La página de detalles de la API se divide en tres áreas: el área ①, en la parte superior, muestra el nombre de la API, la descripción y el acceso para editarla; el área ②, en el panel izquierdo, presenta la información básica y técnica; y el área ③, en el panel derecho, usa pestañas para mostrar contenido detallado como parámetros, ejemplos de respuesta, linaje y notas de uso. A continuación se describe cada área.

    Área

    Description

    ①

    Haga clic en Edit API para abrir la ventana de edición en el espacio de trabajo de la API. Para obtener más información, consulte API testing, publishing, and version management y Register an external API service.

    Nota

    Si su cuenta no pertenece al espacio de trabajo de la API, contacte al propietario y solicite que la agregue como miembro con el rol Developer. Para obtener más información, consulte Manage permissions on workspace-level services.

    ②

    Esta área muestra la siguiente información de la API:

    • Basic Information: Incluye detalles como Views, Number of Calls, API ID, Workspace, Owner, Created At, Last Updated y Description.

    • Technical Information: Incluye detalles como API Type, Request Method, Response Type, Data Source Type, Data Source Name y Table Name.

    ③

    Esta área muestra la siguiente información de la API:

    • Parameter Information: Muestra los Request Parameters y los Response Parameters de la API.

      • Request Parameters: Incluye detalles de Common Request Parameters y API Request Parameters, como Parameter Name, Parameter Type, Parameter Position, Sample Value, Default Value, Description y Label.

      • Response Parameters: Incluye detalles de Common Response Parameters y API Response Parameters, como Parameter Name, Parameter Type, Sample Value y Description.

    • Sample Response: Si prueba la API antes de publicarla y selecciona Save the correct response example automatically, la respuesta de ejemplo se actualizará según los resultados. Para obtener más información, consulte Test an API. El contenido y la estructura en Sample Response ilustran el formato de respuesta de la API.

    • Lineage Information: Muestra el linaje de datos completo entre tablas, API y aplicaciones. El linaje ascendente de las API de DataService Studio admite los siguientes orígenes de datos: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0 y AnalyticDB for PostgreSQL.

      Nota

      • Una API Generation se crea al encapsular un origen de datos o una tabla; por ello, su linaje incluye tablas de datos, la API y aplicaciones.

      • Una Register API se crea al encapsular una dirección de backend; por ello, su linaje solo incluye la API y aplicaciones.

      • El linaje de datos se genera y actualiza con base T+1.

    • Instructions: Haga clic en Edit para modificar las notas o en View Versions para revisar el historial de cambios.

    • Code: Esta pestaña solo aparece cuando la API es de tipo Script Mode. Permite consultar el código personalizado (como SQL) escrito por el desarrollador. No se muestra para otros tipos de API (modo asistente, registradas o servicio orquestado); para las API en modo asistente, revise el SQL en el editor de desarrollo de API de DataService.

      Nota

      Si localiza una API en modo script mediante un fragmento de código en la búsqueda global de Data Map, el sistema lo redirige automáticamente a la pestaña Code.