GET /api/v1/data/techTips
Use this method to return a list of technical tips that are associated with a specific device.
Note
This REST API requires Lenovo XClarity Orchestrator v1.3 or later.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/techTips
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| deviceUUID={uuid} | Required | Device UUID To obtain the device UUIDs, use GET /api/v1/data/devices. |
The following example return a list of technical tips that are associated with a specific device.
GET https://192.0.2.0/api/v1/data/techTips?deviceUUID=00632D78DE644E23B712E200FE449787
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| results | Array of objects | Information about each tech tip | ||
| abstract | String | Tech tip abstract | ||
| timestamp | String | Timestamp when the tech tip was created This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
| tipID | String | Technical tip ID You can get detailed information for this tech tip from the web using the following URL: https://datacentersupport.lenovo.com/solutions/{techTipID} | ||
| _links | Object | Request metadata (see Links) | ||
The following example is returned if the request is successful.
{
"results": [{
"abstract": "System will hang at 'UEFI DXE INIT' when deploying iSCSI BOFM with QL45262
adapter - Lenovo ThinkSystem",
"timestamp": "2021-01-22T00:00:00.000Z",
"tipID": "HT510220"
},
{
"abstract": "'An Uncorrectable Error has occurred on CPUs' when memory in closed page mode
- Lenovo ThinkAgile and Lenovo ThinkSystem",
"timestamp": "2021-01-22T00:00:00.000Z",
"tipID": "ht510558"
}],
"_links": {
"rel": "self",
"uri": "/api/v1/techTips/07389DD8C45D11E793557ED30AE53667-155B46F6F9064C25ACE5177C69F5E07F"
}
}
Give documentation feedback