Example 3: Configuring the REST step to edit the term

In the REST step, Tom edits the term, which is in the output of the XML Parser step.

About this task

Because Tom has the Information Governance Catalog Glossary Author role, he can read and write content in the business glossary. To modify the term definition, Tom needs the URI for the term, which he got from the XML Parser step. He modifies the term definition by using the HTTP PUT method in the REST step.

Procedure

  1. Click Palette, and then double-click the REST step to add another REST step to the outline. The step is added between the XML Parser step and the Output step.
  2. On the General page, select PUT from the HTTP method list.
  3. In the URL field, specify a URL string that includes job parameters:
    1. Click Insert Parameter.
    2. In the Insert Parameter window, select the BGServer job parameter, to include in the URL.
    3. In the Local parameter field, enter uri to add the local parameter to the URL.
    4. Click OK to add the parameter to the URL.
    5. Repeat steps a, b and d to enter the BGPort job parameter to the URL.
    6. Enter the rest of the URL manually: https://#BGServer#:#BGPort#/<uri>

    In this example, uri is the local parameter that must be mapped to the uri field of the XML Parser step on the Mappings page.

  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 Trustore type list, select PKCS12.
    5. In the Trustore 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 Request page, specify information about the request body of the REST web service:
    1. Select the Load the outgoing body from check box.
    2. From the Content type list, select application/xml.
    3. From the Encoding list, select UTF-8.
    4. Select the A file whose path is set on the Mappings page as bodyFilePath check box.

    The bodyFilePath node is created on the Mappings page. You will map the bodyFilePath node to the path for the source file that contains the request body. The request body contains term details with the correct definitions.

  6. 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.
  7. On the Mappings page, map the following items:
    1. Map the uri node to the uri field of the XML Parser step.
    2. Map the bodyFilePath node to the constant value, '#Directory#TermInput.xml', which specifies the path of the XML file that contains the request body.

    The following figure shows that the Target items are mapped to the Source items.

    This figure shows the Mappings page of the Rest step.
Parent topic: Example 3: Updating InfoSphere Information Governance Catalog terms by using the REST API