List Customer Commits Using GET

Get a list of SOV contract customer commitments. Supported selectors: name

Pre-authorized roles: Operations, Read Only

Request

URI

GET

https://{api_host}//vcp.vmware.com/api/provider/v1/contracts/{contractId}/customerCommitments

COPY

Path Parameters

string

contractId

Required

Contract id

contractId example

630c2f68-xxxx-xxxx-xxxx-61f8245eaca1

Query Parameters

string

filter

Optional

FIQL format

integer

limit

Optional

limit

integer

offset

Optional

offset

string

sort

Optional

sort

Responses

200

Returns PageOfCompactCustomerCommitment of type(s) application/json

{
    "content": [
        {
            "id": "1928cac2-xxxx-xxxx-xxxx-045625c0db08",
            "customer": {
                "id": "c7240730-xxxx-xxxx-xxxx-70be00000001",
                "customerNumber": 1000000001,
                "name": "Steven"
            },
            "bol": "2023-06",
            "eol": "2024-05",
            "commitment": 120,
            "status": "ACTIVE",
            "minCommits": {
                "2023-06": 10,
                "2023-07": 10,
                "2023-08": 10,
                "2023-09": 10,
                "2023-10": 10,
                "2023-11": 10,
                "2023-12": 10,
                "2024-01": 10,
                "2024-02": 10,
                "2024-03": 10,
                "2024-04": 10,
                "2024-05": 10
            },
            "name": "my_commitment"
        }
    ],
    "total": 1
}

array of CompactCustomerCommitment

content

Optional

content

integer As int64 As int64

total

Optional

total

400

Bad Request

Operation doesn't return any data structure

401