Skip to main content

Using this REST API

Review this information to learn about how to use the Lenovo XClarity Orchestrator REST API, including authentication requirements, response codes and error handling, and filtering and sorting.

  • Authorization and authentication
    When programming with the Lenovo XClarity Orchestrator REST APIs, you must authenticate using a user ID and password. The user ID must have the correct authorization to perform the intended task.
  • Paginating, scoping, filtering, sorting, including data, and excluding data in responses
    You can use query parameters to limit the number of returned objects and to include, exclude, filter, and sort data in the response body.
  • Response codes
    The Lenovo XClarity Orchestrator REST APIs use the HTTP protocol for sending and retrieving data. Client code using the REST APIs makes an HTTP request to the XClarity Orchestrator server and processes the HTTP response accordingly. Included with the HTTP response data is the HTTP status code. The status code provides some indication as to the success of the HTTP request and can provide information about how to handle the included response data.
  • Links
    Each GET request returns information about the URIs for the resource or resource instance.
  • Metadata
    If a GET request returns multiple instances of a resource type, the response body returns the _metadata attribute. The _metadata attribute contains information that describes the returned data, including the request URL, total number of resources instances, pagination information, and the common query parameters that are supported by the request. If common query parameters are not specified, default values are returned.
  • Status messages
    The status message attributes identify the success or failure of a REST API operation.