Example 3: Configuring the REST step to get the term

In the REST step, Tom specifies the URL and uses the HTTP GET method to get the term that has an incorrect definition. IBM® InfoSphere® Information Governance Catalog supports a set of APIs that you can include in the URL to implement the REST web services. Information Governance Catalog REST APIs are secured with Secure Socket Layer (SSL).

About this task

Tom searches for the term name, 012 Farming Of Animals, which has an incorrect definition by using the HTTP GET method in the REST step.

Procedure

  1. In the outline, click the REST step.
  2. On the General page, select GET from the HTTP method list.
  3. In the URL field, specify a URL string that includes the job parameters:
    1. Click Insert Parameter.
    2. In the Insert Parameter window, select theBGServer job parameter.
    3. Click OK to add the parameter to the URL.
    4. Repeat steps a to c to enter the BGPort job parameter to the URL.
    5. Enter the rest of the following URL manually: https://#BGServer#:#BGPort#/ibm/iis/bgrestapi/v4/search?pattern=012%20Farming%20Of%20Animals&queriedClasses=term

    In this URL, 012 Farming Of Animals, is the pattern to search for the term class of the business glossary.

  4. On the Security page, specify information about the security of the IGC REST API.
    1. From the Authentication list, select Basic, and then specify the user name and password to use to access the REST web service.
    2. Select the Enable SSL check box because IGC REST APIs are secured with SSL.
    3. Select the SSL server authentication check box.
    4. From the Truststore type list, select PKCS12.
    5. In the Truststore file field, specify the path of the truststore file iis-client-truststore.p12, which is available in the Information Server/ASBNode/conf folder.
  5. On the Response page, specify information about the response body of the REST web service:
    1. Select the Pass the received body to check box.
    2. Select the A text node named body in the Output schema option.
    3. From the Content type list, select application/xml.

    The REST step gets the response body, which contains the term with an incorrect definition, in XML form. The response body of the REST step is the input for the XML Parser step.