Summary of changes in the REST API for v3.0

Lenovo XClarity Administrator v3.0 supports enhancements to the Open REST API.

This documentation includes new methods and parameters that apply to the current XClarity Administrator release and later. If you are using an earlier release of XClarity Administrator, you can use the REST API Reference PDF for a list of methods and parameters that apply to that specific release. To find PDFs for the release that you need, see PDF files.

The following methods were added or updated in this release.
  • Inventory resources

  • Job resources

    • POST /tasks/schedules. Added the options, restBody, restMethod, restURL, and type request attributes under triggerAction to specify a custom action.
  • Monitoring and event resources

  • Server-configuration resources

    • Added the 403 response code (Forbidden) to indicate that advanced functions (including OS deployment) are disabled because the number of each managed server exceeds the number of active licenses.
  • Firmware update resources

    • PUT /updateRepositories/firmware. Added the refreshThenAcquire value to the action query parameter to retrieve information about latest available firmware updates from the Lenovo XClarity Support website, and download the updates that are not already downloaded.
    • PUT /updateRepositories/firmware/uxsps. Added the refreshThenAcquire value to the action query parameter to retrieve information about latest available UXSPs from the Lenovo XClarity Support website, and download the UXSPs that are not already downloaded.
  • Operating-system deployment resources

    • Added the 403 response code (Forbidden) to indicate that advanced functions (including OS deployment) are disabled because the number of each managed server exceeds the number of active licenses.
    • GET /osdeployment/globalSettings. Removed the licenseKeys. win2012r1 response attribute. You can no longer deploy Windows 2012 R1.
    • PUT /osdeployment/globalSettings. Removed the licenseKeys. win2012r1 request attribute. You can no longer deploy Windows 2012 R1.
  • Metrics resources