Get All Product Snapshots Using GET

This API is used to get all product snapshots in hierarchical structure.

Request

URI

GET

https://{api_host}/lcm/lcops/api/environments/{environmentId}/products/{productId}/snapshot/inventory

COPY

Path Parameters

string

environmentId

Required

environmentId

string

productId

Required

productId

Query Parameters

string

tenantId

Optional

tenantId

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns Array of SnapshotInventoryDetailsDTO of type(s) application/json

[
    {
        "childrenSnapshots": [
            "SnapshotInventoryDetailsDTO Object"
        ],
        "currentSnapshot": false,
        "description": "string",
        "invalidSnapshotNodes": [
            {
                "properties": {
                    "properties": "string"
                },
                "type": "vrava-primary"
            }
        ],
        "missingSnapshotNodes": [
            {
                "properties": {
                    "properties": "string"
                },
                "type": "vrava-primary"
            }
        ],
        "parentSnapshotId": "string",
        "quiesceSnapshot": false,
        "shutdownSnapshot": false,
        "snapshotGeneratedTime": 1596774385117,
        "snapshotId": "string",
        "snapshotName": "vra_snapshot1 - Fri Aug 07 04:31:34 UTC 2020",
        "snapshotWithMemory": false,
        "status": "string",
        "validSnapshotNodes": [
            {
                "properties": {
                    "properties": "string"
                },
                "type": "vrava-primary"
            }
        ]
    }
]

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

Operation doesn't return any data structure

409

Conflict

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