For example, include the Business Glossary API in an application for a tablet reader that is available to all employees in an organization who use tablet readers at work. An employee may need to look up a business term that is maintained in the organization's business glossary. The employee can use the application to search for the business term.

In this example, the Business Glossary API uses the following base URI for both HTTP GET and HTTP POST calls:

http://FQHN:8085/analyst

The following section of the URI must match the host name and port number of the machine on which the Analyst Service runs:

http://FQHN:8085/

You can use this base URI to construct the Business Glossary API URLs. If you are using an SSL connection, replace

http

with

https.

You can include the following Business Glossary API steps in the application:

Authenticate a user with the Analyst tool.
Search for a business term named "audit" in the business glossary.
Retrieve "owner" and "usageContext" from the business term details.
Navigate the business glossary to get a related business term.
View the business term in the Analyst tool.