Get Reservations

Get Reservations

Returns a page of the reservations, with different content in extensionData depending on the parameter specified in expandMode.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/services/{serviceId}/reservations
COPY
Path Parameters
string
serviceId
Required

The ID of the IaaS service as registered in the component registry service.

Query Parameters
string
category
Optional

IaaS reservation type e.g. Virtual, Cloud, Physical, Machine

string
expandMode
Optional

Expand reservation on its extended data. e.g. reservation, reservationInfo, reservationId

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200
[
    {
        "alertPolicy": {
            "alerts": [
                {
                    "referenceResourceId": "string",
                    "alertPercentLevel": 0
                }
            ],
            "recipients": [
                "string"
            ],
            "frequencyReminder": 0,
            "emailBgMgr": false,
            "enabled": false
        },
        "reservationTypeId": "string",
        "reservationPolicyId": "string",
        "priority": 0,
        "version": 0,
        "extensionData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "enabled": false,
        "lastUpdated": "string",
        "subTenantId": "string",
        "createdDate": "string",
        "name": "string",
        "tenantId": "string",
        "id": "string"
    }
]