Get Product Patch Details V2 Using GET

Get Product Patch Details V2 Using GET

This API is used to get downloaded product patch details by ID.

Request
URI
GET
https://{api_host}/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/patches/{patchId}
COPY
Path Parameters
string
environmentId
Required

environmentId

string
patchId
Required

patchId

string
productId
Required

productId


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Patch of type(s) application/json
{
    "extract": true,
    "metadataId": "vrlcm-vra-8.2.0-8.2.0.13070",
    "metadataVersion": 1,
    "patchBundleCreationDate": 1604913916957,
    "patchCounter": 2,
    "patchDownloadStatus": "DOWNLOADED",
    "patchFileName": "vrlcm-vra-8.2.0-8.2.0.13070.patch",
    "patchId": "600be72d-d367-4ec6-97df-7653g35a8839",
    "patchInfo": {
        "additionaInfo": {},
        "category": "bugfix",
        "description": "vRSLCM wrapped vRealize Automation, version 8.2.0.13070 Patch1",
        "eulaFile": "string",
        "kbUrl": "https://kb.vmware.com/kb/1234",
        "name": "vRealize Automation, version 8.2.0.13070",
        "releaseDate": 1604913174412,
        "releaseType": "patch",
        "summary": "vRSLCM wrapped vRealize Automation, version 8.2.0.13070 Patch1",
        "urgency": "critical"
    },
    "patchRunningCounter": 1,
    "patchSha256sum": "77ddcbf07c1400ec40579aafb20847c95a145054d55d677292546f8a3570ec78",
    "patchSize": 6010020858,
    "patchStatus": "ACTIVE",
    "payload": {
        "patchPayloadFilename": "Prelude_VA-8.2.0.13070-17018655-updaterepo.iso",
        "patchPayloadSize": 107257098,
        "patchPayloadUri": "string",
        "productMinorLevel": "8.2.0.13070",
        "productPatchLevel": "HF1",
        "sha256sum": "e2e884007h8f6d404a2e85d25b40abb268599cd3c4f558344a7d6b78d2240b02"
    },
    "product": {
        "additionaInfo": {},
        "patchAlreadyApplied": false,
        "productBuild": "<product build number>",
        "productId": "vra",
        "productName": "vRealize Automation",
        "productPatchBuild": "<product patch build number>",
        "productVersion": "8.2.0",
        "supportedVersions": [
            "8.2.0"
        ]
    },
    "selfPatch": false
}
boolean
extract
Optional

Extract flag is enabled for vRA version >= 8.0.0

string
metadataId
Optional

Metadata ID

string
metadataVersion
Optional

Metadata version

integer As int64 As int64
patchBundleCreationDate
Optional

Patch Bundle Creation Date

string
patchCounter
Optional

Patch Counter

string
patchDownloadStatus
Optional

Patch download status

string
patchFileName
Optional

Patch file name

string
patchId
Optional

Patch ID

patchInfo
Optional

patchInfo

integer As int32 As int32
patchRunningCounter
Optional

Patch running counter

string
patchSha256sum
Optional

Patch sha256sum value

integer As int64 As int64
patchSize
Optional

Patch size

string
patchStatus
Optional

Patch Status

Possible values are : ACTIVE, REVOKED,
payload
Optional

payload

product
Optional

product

boolean
selfPatch
Optional

Self Patch


400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


Deployments Controller Operations
POST
Apply Product Patch V2 Using POST
POST
Check Product Health V2 Using POST
POST
Create Product Snapshot Request V2 Using POST
Deprecated
PUT
Create Product Update Certificate Request V2 Using PUT
POST
Create Product Upgrade Request V2 Using POST
DELETE
Delete Product Data Source Request V2 Using DELETE
DELETE
Delete Product Logs Using DELETE
DELETE
Delete Product V2 Using DELETE
GET
Download Product Logs V2 Using GET
GET
Export Product V2 Using GET
POST
Generate Product Logs V2 Using POST
GET
Get All Product Snapshots V2 Using GET
Deprecated
GET
Get Compatablity Matrix V2 Using GET
GET
Get Deployed Product Vms V2 Using GET
GET
Get Product Certificate V2 Using GET
GET
Get Product Details V2 Using GET
GET
Get Product Patch Details V2 Using GET
GET
Get Product Snapshot By Snapshot Name V2 Using GET
Deprecated
POST
Power On Product V2 Using POST
POST
Revert Product Snapshot Request V2 Using POST
Deprecated
POST
Shut Down Product V2 Using POST
POST
Trigger Inventory Sync For Product V2 Using POST
PUT
Update Node Password Request V2 Using PUT
PUT
Update Product Admin Password Request V2 Using PUT
PUT
Update Product Data Source Password Request V2 Using PUT
POST
Validate Patch Product V2 Using POST
POST
Validate Product Data Source Password Request V2 Using POST
POST
Validate Product Update Certificate Request V2 Using POST
POST
Validate Vertical Scale Up Request V2 Using POST
POST
Vertical Scale Up Request V2 Using POST