Gets all Reservations. | vRealize Automation Reservation Service API

Gets all Reservations.

Gets all Reservations with specified paging, sorting and filtering parameters. Filtering is only supported on 'name', 'reservationTypeId', 'subTenantId', 'enabled', 'tenantId' and 'reservationPolicyId' fields.

Request

URI

GET

https://{api_host}/reservation-service/api/reservations

COPY

Query Parameters

string

category

Optional

the id of the reservation to update

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

successful operation

Returns PageReservationInfo of type(s) */*

{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "reservationTypeRef": {
                "id": "string",
                "label": "string"
            },
            "name": "string",
            "tenantId": "string",
            "subTenantRef": {
                "id": "string",
                "label": "string"
            },
            "id": "string",
            "priority": 0,
            "enabled": false,
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "reservationPolicyRef": {
                "id": "string",
                "label": "string"
            }
        }
    ],
    "first": false,
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

size

Optional

size

boolean

last

Optional

last