[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
Get Request By ID V2
DescriptionThis API is used to get the information about a request triggered.
Request
URLURL
https://localhost:8080/lcm/request/api/v2/requests/{requestId}
Path Parameters
Path Parameters
string
requestId
Required
requestId
Authentication
This operation uses the following authentication methods.
Authorization
Scopes:
global
Response
Response
Response BodyResponse Body
200 OK
Returns
RequestDTO
of type(s) application/json
{
"createdBy": "admin@local",
"executionId": "e53ba5c9-1f6a-4cda-8ba6-6d6274441900",
"requestName": "lcmgenricsetting",
"requestReason": "Get Generic Settings",
"requestSourceType": "user",
"requestType": "lcmgenricsetting",
"state": "CREATED",
"vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}
string
createdBy
Optional
Created By User
string
errorCause
Optional
Error Cause
string
executionId
Optional
Execution Id
string
executionPath
Optional
Execution Path
string
executionStatus
Optional
Execution Status
map of
object
inputMap
Optional
string
isCancelEnabled
Optional
Is Cancel Enabled?
integer as int64
lastUpdatedOn
Optional
Last Updated Time
map of
object
outputMap
Optional
string
requestName
Optional
Request Name
string
requestReason
Optional
Request Reason
string
requestSource
Optional
Request Source
string
requestSourceType
Optional
Request Source Type
string
requestType
Optional
Request Type
string
resultSet
Optional
Result Set
string
state
Optional
State
string
transactionId
Optional
string
vmid
Optional
Errors
GenericErrorResponseDTO
400
Bad Request
401
Unauthorized
403
Forbidden
GenericErrorResponseDTO
404
Not Found
GenericErrorResponseDTO
500
Internal Server Error
Code Samples
cURL Command
curl https://localhost:8080/lcm/request/api/v2/requests/{requestId}
[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
On This Page
Request Controller Operations
patch
