Example 3: Updating InfoSphere Information Governance Catalog terms by using the REST API

In this example, a business analyst creates a job that uses the InfoSphere® Information Governance Catalog REST API to invoke the REST web service. He searches for a term that has an incorrect definition in the business glossary and then corrects the term definition.

About this task

The InfoSphere Information Governance Catalog REST API is used by client applications to access and create business glossary content. The REST service exposes the data that is stored in the business glossary as resources. These resources are addressed by uniform resource identifier (URI)s and are represented by XML documents.

Tom, a business analyst, is responsible for managing business vocabulary, defining the business processes, and defining the terms that are used in the business glossary of the company. One day, when Tom reviews the business glossary for his company, he is surprised to see that the definition of the term 012 Farming Of Animals is not accurate. He uses the Hierarchical Data stage to correct the definition of the term.

To modify the definition, Tom needs the URI for the term. He then searches for the term name by using the HTTP GET method. The REST step provides the response body for the term in XML form. Then, the XML Parser step parses the response body of the REST step, which is the XML document, to get the URI of the term. The URI of the term is the input for the next REST step, which corrects the term definition by using the HTTP PUT method.