Resource /webmapi/storage/shelvesExpand | Collapse

APIs for shelves

Get shelf information
Description

Get shelf information

HTTP Example

GET /webmapi/storage/shelves

Output

Reports successful result in ResponseContentType<ContainerType<ShelfDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
SHELF_LIST_INFO_MAPI_SES_NO_EXIST29010Shelf ID or name provided does not match any shelves.
SHELF_LIST_INFO_STORAGE_INVALID_PARAMETER29011Invalid name or UID.
Produces

application/json

Since

1.0

Get a specified shelf instance
Description

Get a specified shelf instance

HTTP Example

GET /webmapi/storage/shelves/{id}

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<ShelfDetailsInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
SHELF_LIST_INFO_MAPI_SES_NO_EXIST29010Shelf ID or name provided does not match any shelves.
SHELF_LIST_INFO_STORAGE_INVALID_PARAMETER29011Invalid name or UID.
Produces

application/json

Since

1.0