API Guide

Back Next

API Reference Overview

The API Reference describes the Business Glossary API URIs, the query parameters, return values, possible responses, and error codes.

The Business Glossary API uses the following base URI:

http://FQHN:port/analyst

For SSL connections, the Business Glossary API uses the following base URI:

https://FQHN:port/analyst

You can use the following API URI requests to retrieve information from a business glossary that is in the Analyst Service:

GET /bg.auth/domainList: Lists the available domains or namespaces for user login.
POST /bg.auth/login: Obtain an authentication cookie based on user credentials.
GET /glossary/api/v3/search: Returns a particular business term that matches a search string.
GET /glossary/api/v3/suggest: Suggests several possible search queries based on the user's query.
GET /glossary/api/v3/term: Returns the details of a published business term, such as attributes, related categories, and related terms.
GET /glossary/api/v3/admin/attributelist: Returns the list of ordered attributes that are available to look up as details for a business term.