Get Reference V2 Using GET

Get Reference V2 Using GET

This API is used to get reference information of a locker entity.

Request
URI
GET
https://{api_host}/lcm/locker/api/v2/references/{vmid}
COPY
Path Parameters
string
vmid
Required

vmid

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LockerEnvResponseDTO of type(s) application/json 
{
    "containers": [
        {
            "containerId": "string",
            "containerName": "string",
            "resourceType": "string"
        }
    ],
    "environments": [
        {
            "envId": "2c692f41-7b78-437f-8325-322350daeedc",
            "envName": "vRS Small Import Environment",
            "products": [
                {
                    "consumption": {},
                    "name": "vrli",
                    "nodes": []
                }
            ]
        }
    ]
}
array of LockerContainerDto
containers
Optional

containers

array of LockerEnvironmentDTO
environments
Optional

environments


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

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


On This Page
Locker References Controller Operations
GET
Get Reference V2 Using GET
GET
Get Ungrouped References V2 Using GET