This documentation supports the 9.1.04 version and its patches of BMC Atrium Core. The documentation for version 9.1 to 9.1 Service Pack 3 and its patches is available here.

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

REST API versioning

The REST API is versioned separately from BMC Atrium Core version 9.0. A given version of BMC Atrium Core can concurrently support multiple API versions. Further versions of the API will be released with future product releases, resulting in multiple concurrent API versions supported by a given BMC Atrium Core version.

How to determine the version

To determine  API versions that are supported by BMC Atrium Core, use the /api/cmdb/v1.0/versions endpoint. This endpoint returns a list of API versions and product information: 

curl -X GET --header 'Accept: application/json' --header 'Authorization: <Your token>'
{
  "applicationVersions": [
    {
      "applicationId": "AR005056B5170DLd#JSQUZQNEQXRkA",
      "applicationName": "BMC Remedy Action Request System",
      "majorVer": 9,
      "minorVer": 1,
      "maintenanceVer": 3,
      "patchNum": 0,
      "stage": 0,
      "exist": true
    },
    {
      "applicationId": "OB00C04FA081BABZlxQAmyflAg1wEA",
      "applicationName": "BMC Atrium CMDB",
      "majorVer": 9,
      "minorVer": 1,
      "maintenanceVer": 3,
      "patchNum": 0,
      "stage": 0,
      "exist": true
    }
  ]
}

Note that this endpoint does not perform authentication checks, it does not require a token to be passed, and it can also be accessed in a browser if required. See Configuring the REST API .

How to view supported features in a version

To see what features are available in each of the supported API versions, view the version-specific swagger file. After you have chosen an API version to use, include the version in the URL for every endpoint you call. The following examples provide some sample URLs for v1.0 of the API: 

/cmdb/v1.0/instances

/cmdb/v1.0/ne/configurations/dataset

/cmdb/v1.0/attributes/{namespace}/{className}

For more information, see Endpoints in the REST API v1.0.


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

Comments