Sample Postman Scripts

Postman is a useful tool for testing REST APIs. See https://www.getpostman.com/ for more information about Postman.

It captures, stores and executes specific REST API calls so you do not have to keep typing the URL and parameters each time you want to issue a request.

Sample Collections

Collections help to group related REST API calls together.

In order to run these, you should have a set of environment variables configured as detailed in the next section (“Environment variables”).

Egeria by default uses https:// requests with a self-signed certificate. Any PostMan users therefore will need to go into settings->general and turn off ‘SSL certificate verification’ or requests will fail.

If interested, you can also learn more about Postman Collections in general.

Egeria Core

Egeria IBM Information Server Connectors

Egeria IBM Information Governance Catalog Connector

  1. Connector configuration and startup
  2. Sample read operations
  3. Sample write operations

To use the sample read operations, you will first need to load the Coco Pharmaceuticals samples to your IBM Information Governance Catalog environment.

Egeria IBM DataStage Connector

The connector should automatically pickup and process any jobs already in your environment; however, you can also load the Coco Pharmaceuticals samples if you have an empty environment.

Egeria Apache Atlas Connector

  1. Connector configuration and startup
  2. Sample read operations
  3. Sample write operations

To use the sample read operations, you will first need to load the Hortonworks Sandbox samples to your Apache Atlas environment.


Environment variables

Postman supports the definition of variables like hostname, kafka queue, userId, etc. These can then be used in specific Postman commands. This makes it easier for them to be used by multiple users, or with different configurations.

A superset of all of the potential variables that we use in our samples (along with default values) are provided in: Egeria.postman_environment.json.

You can either download the linked file and import it into Postman, or always import the latest version by importing from the following link from within Postman: https://raw.githubusercontent.com/odpi/egeria/master/open-metadata-resources/open-metadata-samples/postman-rest-samples/Egeria.postman_environment.json

You will most likely want to override some of these values (such as baseURL or kafkaep) depending on your own environment’s configuration; or you may even want to make several copies of this with different settings in each one to be able to quickly change between different environments you have running at the same time.

Note that many of the variables are optional, depending on your particular configuration. The mandatory variables are the following:

Learn more more about Postman Environments.


License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.