Get all reservations of a storage/equipment compartment

get

https://{targetURL}/api/v1/storageLayers/{storageLayerID}/reservations

Returns the reservations made for the given compartment — both user-specific and role-based, current and historical. Use the notExpired, from, to, start, and end filters to narrow the window. Reservations live on individual compartments rather than parent storage units, so each compartment must be queried separately.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

storageLayerID

int32

required

Query Params

$expand

string

Expand an ID field to an object

$sort

string

Sort by a specific field

$page

string

Set the current page (0 based)

$records

string

Set the number of records to return (1000 maximum)

$viewID

string

Specify a viewID to customize the result

$viewColumns

string

Specify viewColumns to extend the result

reservationType

string

Filter by UserReservation or RoleReservation

reservedForID

string

Filter by the ID (a userID or a roleID) for which reservations were made

createdByUserID

string

Filter by the userID who created the reservation

from

string

Search for reservations starting from this date/time

string

Search for reservations ending at this date/time

notExpired

string

Filter by non-expired reservations (true/false)

start

string

Filter by the exact start date/time

end

string

Filter by the exact end date/time

isPermanent

string

Filter by (non-)permanent reservations (true/false)

Headers

X-Requested-With

string

Defaults to Swagger

Responses

200

Storagelayer reservations were successfully retrieved.

400

Storagelayer reservations could not be retrieved due to malformed inputs.

401

You do not have the permission to view storagelayer reservations.

403

You do not have permission to view storage compartments.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!