This documentation supports the 9.0 version of BMC Atrium Core.

To view the latest version, select the version from the Product version menu.

API examples

In this section you will find some practical examples on how to use the REST operations with Postman - REST Client.

Before you begin

  1. Open Google Chrome.
  2. Install the Postman plug-in to test the REST operations.
    For more information to install Postman, see https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm
  3. From the Google Chrome tool-bar, click Apps.
  4. Click Postman - REST Client to launch the application.

To create an instance

  1. Open the Postman - REST Client.
  2. Create a token. For more information, see Creating a token.
  3. Set Request URL as:   http://<midtier>:<port>/api/cmdb/v1/instance/<datasetId>/<namespace>/<className>
  4. Select Operation as POST.
  5. Click Headers.
  6. Enter the following data as key value pair in the header:

    Key
    Value
    AuthorizationAR-JWT <token generated>
    Content-Typeapplication/json
  7. Select raw.
  8. From the list, select JSON.
  9. Enter the JSON input for creating an instance.
  10. Click Send to send the request.
  11. Click Headers.
  12. The plugin returns an URL in the Location section for the newly created entry.

To retrieve an instance

  1. Open the Postman - REST Client.
  2. Create a token. For more information, see Creating a token.

  3. Set Request URL as:  http://<midtier>:<port>/api/cmdb/v1/instance/<datasetId>/<namespace>/<className>/<instanceId>
  4. Select the operation as GET.
  5. Click Headers.
  6. Enter the following data as key value pair in the header:

    Key
    Value
    AuthorizationAR-JWT <token generated>
  7. Click Send.
  8. Click Body and verify the details of the Request ID.

Related topics

Was this page helpful? Yes No Submitting... Thank you

Comments