Get Request By Id V2 Using GET

This API is used to get the information about a request triggered.

Request

URI

GET

https://{api_host}/lcm/request/api/v2/requests/{requestId}

COPY

Path Parameters

string

requestId

Required

requestId

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns RequestDTO of type(s) application/json

{
    "createdBy": "admin@local",
    "errorCause": "string",
    "executionId": "e53ba5c9-1f6a-4cda-8ba6-6d6274441900",
    "executionPath": "string",
    "executionStatus": "string",
    "inputMap": {
        "inputMap": {}
    },
    "isCancelEnabled": "string",
    "lastUpdatedOn": 0,
    "outputMap": {
        "outputMap": {}
    },
    "requestName": "lcmgenricsetting",
    "requestReason": "Get Generic Settings",
    "requestSource": "string",
    "requestSourceType": "user",
    "requestType": "lcmgenricsetting",
    "resultSet": "string",
    "state": "CREATED",
    "transactionId": "string",
    "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

object

inputMap

Optional

inputMap

string

isCancelEnabled

Optional

Is Cancel Enabled?

integer As int64 As int64

lastUpdatedOn

Optional

Last Updated Time

object

outputMap

Optional

outputMap

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

transactionId

string

vmid

Optional

vmid

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