Get storage units/equipment

get

https://{targetURL}/api/v1/storage

Note: the storage calls can return both storage units and equipment. You can differentiate between the two with the storage type's deviceType field which is either STORAGE or EQUIPMENT.

The hasPlanner and hasValidation properties are required for an EQUIPMENT storageType.

Setting hasPlanner to true will show the equipment calendar in eLab.

Setting hasValidation to true will show the equipment validation options in eLab and enable checking the validation. See the storageValidation calls. This is only supported for equipment, not storage units.

$expand values (separate with a comma for multiple expands):

storageLayer
managers
institute
meta

Note: the expand statistics is not available for this call because it's a resource intensive operation. You can only get a storage unit's statistics with the GET /storage/{storageID} call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

name

string

Filter by name

storageTypeID

string

Filter by storageTypeID

storageTypeName

string

Filter by the storageType name

deviceType

string

Filter by the storage type's device type (STORAGE or EQUIPMENT)

storageMetaName

string

Filter by storageMeta name

string

Search term to use for filtering

status

string

Filter by status

Headers

X-Requested-With

string

Defaults to Swagger

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK