Get Ungrouped References V2 Using GET

This API is used to get paginated ungrouped references information of a locker entity.

Request

URI

GET

https://{api_host}/lcm/locker/api/v2/references/ungrouped/{vmid}

COPY

Path Parameters

string

vmid

Required

vmid

Query Parameters

string of array

envQuery

Optional

envQuery

integer

from

Optional

from

integer

size

Optional

size

string

sortBy

Optional

sortBy

string of array

typeQuery

Optional

typeQuery

string of array

userQuery

Optional

userQuery

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns ReferencePageDTO of type(s) application/json

{
    "page": 0,
    "references": [
        {
            "destinationName": "vrbc",
            "envId": "47adcab7-d02c-4569-8976-50bba9360293",
            "envName": "vRS Small Import Environment",
            "lockerId": "2c692f41-7b78-437f-8325-322350daeedc",
            "meta": {},
            "referenceType": "password",
            "transactionId": "string",
            "type": "product",
            "vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
        }
    ],
    "total": 1
}

integer As int64 As int64

page

Optional

Page

array of LockerRefRequestDTO

references

Optional

References

integer As int64 As int64

total

Optional

Total

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