After obtaining a Token to access IMS API services, you can proceed to use Postman to submit requests for data.
Creating New GET Requests
GET requests are OData queries used to retrieve data from the Data Lake.
To create a new GET request:
Click Add a request in the left-hand panel of Postman.
Click Add a request.
The New Request tab will open in Postman.
Enter your query parameters.
Example:
For demonstration purposes, we will prepare a query that will:
Return records containing a FLOC Description equal to "PRESSURE VESSEL" ($filter=FlocDescription eq 'PRESSURE VESSEL').
Return only the first 10 records ($top=10).
Start from the first record ($skip=0).
Putting these items together we can create a query and enter it in the GET query textbox as follows:
https://ims-datalake.shell.com/odata/datalakehierarchy?$filter=FlocDescription eq 'PRESSURE VESSEL'&$top=10&$skip=0
Query parameters can be changed by changing the query directly or through the Query Params table.
Entering query parameters.
To reuse your query at a later date:
Click the Edit button.
Enter your desired query name.
Click Save.
Click the Edit button, rename, and click Save.
Take Note
In Example Queries you can find more information on creating queries and examples of possible queries.
Submitting GET Requests
When you are ready to submit your query:
Click Send to view the results of your query in Postman.
The query results will be returned in the Body tab.
Results of a query displayed in Postman.
To use the results of the query in another application:
Click the expand arrow next to Send and click Send and Download.
Click Send and Download.
The results of the query will be returned as a JSON file.
Follow the prompts to save the file in your desired location.
Note: If more than an hour has passed since you obtained your token, request a new Token.