Use this API to retrieve all available Patch Planning inventory by using filters.
Resource Information
| Response formats | JSON |
| Requires authentication? | Yes |
| Rate limited? | All API calls are automatically rate limited to a maximum of 10 calls per second. |
Request Syntax
GET /v2/patch-planning/inventory/resources?type={type}&updateStatus={update_status}
URI Request Parameters
The request uses the following URI query parameters:
| Parameter | Required? | Description |
| type | Optional | Filter by inventory type (VIOS, HMC, FW, AIX, Linux, IBMI, Adapter) |
| updateStatus | Optional | Filter by update status (endOfSupport, upToDate, updatesAvailable, upgradesAvailable, notFound) |
Request Headers
Authenticate the API by completing the following steps:
- Set your client ID value in the X-CMC-Client-Id header in every request.
- Set the client secret value in the X-CMC-Client-Secret header in every request.
To form the CMC API full URL, append the relative path of the endpoint you want to use to the Base URL.
Example: https://<portal-url>/api/public/v2/patch-planning/inventory/resources
Response Body
This request does not have a response body.
Response Syntax and Description
To review the response schema and for information about the parameters, see the API_Patch Planning_Response Syntax and Parameter Description.docx topic.
Errors
The following errors are the common errors for this API:
BadRequestException
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
UnauthorizedException
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
NotFoundException
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
TooManyRequestsException
The request has reached its throttling limit. Retry after the specified time.
HTTP Status Code: 429
Sample Request
Review the following examples to understand how the API request and response work.
Sample request with query parameters
GET /api/public/v2/patch-planning/inventory/resources?type=hmc&updateStatus=updatesavailable HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
[
{
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"Name": "xxxxxxxx",
"Type": "hmc",
"CurrentVersion": {
"Version": "xxxxxxxx",
"ReleaseDate": "xxxxxxxx",
"EoSPSDate": "xxxxxxxx",
"Download": "http://www.ibm.com/support/fixcentral/aix/quickorder?fixids=xxxxx&function=xxxxx&includeRequisites=xxxxx&includeSupersedes=xxxxx&release=xxxxx&source=flrt"
},
"LatestRelease": {
"Version": "xxxxxxxx",
"ReleaseDate": "xxxxxxxx",
"EoSPSDate": "xxxxxxxx",
"Download": "http://www.ibm.com/support/fixcentral/aix/quickorder?fixids=xxxxx&function=xxxxx&includeRequisites=xxxxx&includeSupersedes=xxxxx&release=xxxxx&source=flrt"
},
"LatestUpdate": {
"Version": "xxxxxxxx",
"ReleaseDate": "xxxxxxxx",
"EoSPSDate": "xxxxxxxx",
"Download": "http://www.ibm.com/support/fixcentral/aix/quickorder?fixids=xxxxx&function=xxxxx&includeRequisites=xxxxx&includeSupersedes=xxxxx&release=xxxxx&source=flrt"
},
"LatestUpgrade": null,
"RecommendedUpdate": {
"Version": "xxxxxxxx",
"ReleaseDate": "xxxxxxxx",
"EoSPSDate": "xxxxxxxx",
"Download": "http://www.ibm.com/support/fixcentral/aix/quickorder?fixids=xxxxx&function=xxxxx&includeRequisites=xxxxx&includeSupersedes=xxxxx&release=xxxxx&source=flrt"
},
"RecommendedUpgrade": null,
"ExtendedInfo": {
"ManagedSystem": {
"MTMS": {
"MachineType": "9009",
"Model": "22A",
"SerialNumber": "xxxxxxxx"
},
"Name": "xxxxxxxx",
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"ManagingPartitionName": "xxxxxxxx"
},
"UpdateStatus": [
"Updates available",
]
},
…
]
Comments
0 comments
Please sign in to leave a comment.