The Postman Collection that is attached to this page replicates the API Reference pages of the DataTrails Documentation. It provides an easy way to set up an environment and test the API endpoints and it is intended to complement (not replace) the documentation as a source of information.
Access to the API is authenticated using a bearer token that is stored in a global environment variable. Please see this blog post for information about how this works and how to set it up. Most of the configuration is already done, all you should need to do is to enter the values of your Client ID and Client Secret into the Postman API Reference Variables tab.
Each mini collection is self contained and makes use of additional Postman environment variables to pass values from the response of one call to the URL of the next. This means that you can test the API calls with minimal typing and cutting and pasting. You do not need to worry about these, they are pre-configured and the values are automatically set but you can see the values by hovering your mouse over the variable.
The collection variables are set using JavaScript to process the response of a POST API call, for example:
If you see a green dot next to "Tests" in any other API calls this means that the response will be processed and some collection variables set.
The Collections.
- App Registration - create Custom Integrations and retrieve a Bearer Token
- BLOBs - Binary Large OBjects, upload files to your audit trails
- Assets and Events - build an immutable Audit Trail
- Attachments - retrieve details of your BLOBs
- Compliance - create Compliance Policies
- IAM Policies - share access to your tenancy and define permissions
- IAM Subjects - import a subject to use in an IAM policy
- Locations - add locations to your tenancy for use with Events
- Public Assets - retrieve the details of a public Asset
- Tenancies - the tenancy management API
- Tenancy Caps - view the remaining resources for your tenancy