List Contracts Using GET 3
Get a list of contracts. Supported selectors: bolDate, eolDate, status, aggregator.prmId, contractReferenceNumber, contractSKU.code, contractSKU.contractType, contractSKU.productFamily.name, contractSKU.productFamily.code, contractSKU.productFamily.type, contractNumber.
Pre-authorized roles: Auto Report Operations, Operations, Read Only
Request
URI
GET
https://{api_host}//vcp.vmware.com/api/provider/v1/contracts
COPY
Query Parameters
string
filter
Optional
FIQL format
integer
limit
Optional
limit
integer
offset
Optional
offset
string
sort
Optional
sort
Responses
200
OK
Returns PageOfContract of type(s) application/json
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"aggregator": {
"name": "Agg Corp",
"prmId": 2222222
},
"aggregatorContact": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"serviceProviderContact": {
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]"
},
"systemContact": {
"firstName": "Maria",
"lastName": "Williams",
"email": "[email protected]"
},
"licenseContact": {
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
},
"eolDate": "2023-03-20",
"bolDate": "2022-03-21",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"contractNumber": 111111,
"region": "AMER",
"term": 12,
"graceTerm": 1,
"currency": "USD"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
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