Skip to content
This repository was archived by the owner on Aug 11, 2022. It is now read-only.

7.4 Export API Metadata

Chris Wiechmann edited this page Jul 1, 2019 · 3 revisions

For the new Version 2.0 of Embedded Analytics Swagger-Promote, which behaves more like a API-Manager CLI, can be used to extract the required API-Metadata-Information. This is basically a CSV-File containing information about which application has a subscription to which API/API-Method.

To generate such a file run the provided script: scripts/run-metadata-export.bat

"Running API-Registry Metadata export version 1.0.0 ..."
usage: API-Manager Meta-Data Export -f <api-mgr-prod-metadata-export.csv> [-h <api-host>] [-p <changeme>] [-port <8181>] [-u <apiadmin>]
 -f,--filename <api-mgr-prod-metadata-export.csv>   Filename used to export meta-data configuration (relative or absolute).
 -h,--host <api-host>                               The API-Manager hostname the API should be imported
 -p,--password <changeme>                           Password used to authenticate
 -port <8181>                                       Optional parameter to declare the API-Manager port. Defaults to 8075.
 -u,--username <apiadmin>                           Username used to authenticate. Please note, that this user must have Admin-Role
Tool to query your API-Manager registry and exports Metadata in some format.
Originally invented to feed metadata into Axway EA4APIM, but can be extended about other formats.


ERROR: Missing required option: f


You may run one of the following examples:
scripts\run-metadata-export.bat -h localhost -u apiadmin -p changeme -f api-mgr-prod-metadata-export.csv

The tool will create a CSV-File with the following format to be imported to Embedded-Analytics:

ClientApplication,API,APIMethod,GatewayInstanceType,Organization,EventTimeStamp
63ab770b-283e-4a8b-8732-cca6706de714,4fdd4dc7-44c4-4af9-9cd6-deee794945c7,f3ae6975-7efb-4438-ba01-6bcc6a66f4e3,Front-End,57d42d22-a86d-403a-ad6b-d7ca06bf3ac4,"Jul 1, 2019 11:59:59 PM"
63ab770b-283e-4a8b-8732-cca6706de714,4fdd4dc7-44c4-4af9-9cd6-deee794945c7,9f258d68-4b01-41e4-842c-052a3a619dd8,Front-End,57d42d22-a86d-403a-ad6b-d7ca06bf3ac4,"Jul 1, 2019 11:59:59 PM"
63ab770b-283e-4a8b-8732-cca6706de714,4fdd4dc7-44c4-4af9-9cd6-deee794945c7,2db761b8-4c34-416b-9651-983b9d0cae36,Front-End,57d42d22-a86d-403a-ad6b-d7ca06bf3ac4,"Jul 1, 2019 11:59:59 PM"

The module is flexible and can be extended about any other additional format if needed.