GET /v2/patch-planning/inventory/resources

Use this API to retrieve all available patch planning inventory for all the resources.

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
• For a particular resource: GET /v2/patch-planning/inventory/resources/{uuid}
• For a resource of a particular type and update status: GET /v2/patch-planning/inventory/resources?type={type}&updateStatus={update_status}

URI Request Parameters

The request uses the following URI parameters:

Parameter	Required?	Description
uuid	Optional	The universally unique identifier (UUID) for the resource in the inventory. If you do not specify the UUID, details of all the resources in the inventory are displayed.
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:

1. Set your client ID value in the X-CMC-Client-Id header in every request.
2. 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 for all patch planning inventory

GET /api/public/v2/patch-planning/inventory/resources 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
 

Sample Response

[
    {
        "UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "Name": "xxxxxxxx",
        "Type": "aix",
        "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": {
            "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"
        },
        "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": {
            "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"
        },
        "ExtendedInfo": {
            "ManagedSystem": {
                "MTMS": {
                    "MachineType": "9009",
                    "Model": "22A",
                    "SerialNumber": "xxxxxxxx"
                },
                "Name": "xxxxxxxx",
                "UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            },
            "ManagingPartitionName": "xxxxxxxx"
        },
        "UpdateStatus": [
            "Updates available",
            "Upgrade available"
        ]
    },
    …
]