Get Product Commitment Using GET

Get Product Commitment Using GET

Get a product commitment identified by the commitment id. Pre-authorized roles: Operations, Read Only

Request
URI
GET
https://{api_host}//vcp.vmware.com/api/provider/v1/contracts/{contractId}/productCommitments/{commitmentId}
COPY
Path Parameters
string
commitmentId
Required

Commitment id

commitmentId example
775dc4c1-xxxx-xxxx-xxxx-8328ac75e878
string
contractId
Required

Contract id

contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1
Responses
200

OK

Returns ProductCommitment of type(s) application/json 
{
    "id": "775dc4c1-xxxx-xxxx-xxxx-8328ac75e878",
    "name": "my_commitment_1",
    "bol": "2025-01",
    "eol": "2025-12",
    "commitment": [
        {
            "beginMonth": "2025-01",
            "endMonth": "2025-12",
            "quantity": 100
        }
    ],
    "product": {
        "id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
        "code": "VR-OSTACK4-C",
        "name": "VMware Integrated OpenStack"
    },
    "uom": "GB vRAM",
    "customer": {
        "id": "c7240730-xxxx-xxxx-xxxx-250300000003",
        "customerNumber": 1000000001,
        "name": "Steven"
    },
    "payment": "MONTHLY",
    "status": "ACTIVE",
    "term": "YEAR_1"
}
string
id
Optional

id

string
name
Optional

Commitment name

string
bol
Optional

Begin month of the commitment

string
eol
Optional

End month of the commitment

array of Commitment
commitment
Optional

commitment

BriefProduct
product
Optional

product

string
uom
Optional

uom

Customer
customer
Optional

customer

string
payment
Optional

payment

string
status
Optional

status

Possible values are : ACTIVE, COMPLETED,
string
term
Optional

term

Possible values are : YEAR_1, YEAR_3, YEAR_4, YEAR_5,

400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

On This Page
Product Commitment Operations
POST
Create Subline Term Commit Using POST
GET
Get Product Commitment Using GET
GET
List Product Commitments Using GET
POST
Renew Using POST
PATCH
Update Commit Name Using PATCH