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.
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 IBM Information Governance Catalog Connector
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.
To use the sample read operations, you will first need to load the Hortonworks Sandbox samples to your Apache Atlas environment.
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
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:
baseURL: the base URL of your Egeria OMAG Server Platform, including the ‘https://’ prefix
user: the user name of the user carrying out operations within the Egeria OMAG Server Platform
server: the name of the server within the Platform in which to carry out operations
cohort: the name of the cohort with which the server should interact
kafkaep: the Apache Kafka endpoint (hostname:port) to use for Egeria’s event bus
License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.