Pending Assets Viewer (0.0.1)

API for querying and retrieving pending device assets information in Ruckus Cloud platform. This service provides read only endpoints for searching and retrieving device assets (Access Points and Switches) with advanced filtering, pagination, and sorting capabilities.

Ruckus Network Technical Documents

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

Servers

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud

RUCKUS One API host for North American region.

https://api.ruckus.cloud

Pending Assets Viewer

Retrieve pending asset information including access points and switches.

Operations

Query Switch Device Assets

Request

Retrieve switch device assets based on search criteria with pagination support.

Body

required

pageinteger(int32)>= 0required

Page number for pagination (0-based).

Example: 0

sizeinteger(int32)>= 1required

Number of items per page.

Example: 20

includeHiddenboolean

Whether to include hidden devices in the results.

Example: false

sortColumnstring

Column name to sort by.

Enum"serialNumber""model""shipDate""createdDate""hiddenStatusName"

Example: "createdDate"

orderstring

Enum"ASC""DESC"

Example: "ASC"

searchTextstring

Text to search for in device information.

Example: "T610"

filterModelsArray of strings

List of model names to filter by.

Example: ["R650","R610","R670"]

dayRangestring

Date range filter for device creation.

Enum"SEVEN_DAYS""FOURTEEN_DAYS""THIRTY_DAYS"

createdDateFromstring(date)

Start date for device creation filter.

Example: "2024-01-01"

createdDateTostring(date)

End date for device creation filter.

Example: "2024-12-31"

{
  "page": 0,
  "size": 20,
  "includeHidden": false,
  "sortColumn": "createdDate",
  "order": "ASC",
  "searchText": "T610",
  "filterModels": [
    "R650",
    "R610",
    "R670"
  ],
  "dayRange": "SEVEN_DAYS",
  "createdDateFrom": "2024-01-01",
  "createdDateTo": "2024-12-31"
}

Responses

Successfully retrieved Switch device assets

Body

contentArray of objects(DeviceResponseDto)

List of items for the current page.

pageableobject(PageableInfo)

Pagination information.

totalPagesinteger(int32)

Total number of pages.

Example: 1

totalElementsinteger(int64)

Total number of items across all pages.

Example: 5

lastboolean

Whether this is the last page.

Example: true

numberOfElementsinteger(int32)

Number of elements in the current page.

Example: 5

sizeinteger(int32)

Number of items per page.

Example: 10

numberinteger(int32)

Current page number (0-based).

Example: 0

sortobject(SortInfo)

Sorting information.

firstboolean

Whether this is the first page.

Example: true

emptyboolean

Whether the current page is empty.

Example: false

Response

{
  "content": [
    { … }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": { … },
    "offset": 0,
    "unpaged": false,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 5,
  "last": true,
  "numberOfElements": 5,
  "size": 10,
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "empty": false
}

Query Access Point Device Assets

Request

Retrieve access point device assets based on search criteria with pagination support.

Body

required

pageinteger(int32)>= 0required

Page number for pagination (0-based).

Example: 0

sizeinteger(int32)>= 1required

Number of items per page.

Example: 20

includeHiddenboolean

Whether to include hidden devices in the results.

Example: false

sortColumnstring

Column name to sort by.

Enum"serialNumber""model""shipDate""createdDate""hiddenStatusName"

Example: "createdDate"

orderstring

Enum"ASC""DESC"

Example: "ASC"

searchTextstring

Text to search for in device information.

Example: "T610"

filterModelsArray of strings

List of model names to filter by.

Example: ["R650","R610","R670"]

dayRangestring

Date range filter for device creation.

Enum"SEVEN_DAYS""FOURTEEN_DAYS""THIRTY_DAYS"

createdDateFromstring(date)

Start date for device creation filter.

Example: "2024-01-01"

createdDateTostring(date)

End date for device creation filter.

Example: "2024-12-31"

{
  "page": 0,
  "size": 20,
  "includeHidden": false,
  "sortColumn": "createdDate",
  "order": "ASC",
  "searchText": "T610",
  "filterModels": [
    "R650",
    "R610",
    "R670"
  ],
  "dayRange": "SEVEN_DAYS",
  "createdDateFrom": "2024-01-01",
  "createdDateTo": "2024-12-31"
}

Responses

Successfully retrieved AP device assets

Body

contentArray of objects(DeviceResponseDto)

List of items for the current page.

pageableobject(PageableInfo)

Pagination information.

totalPagesinteger(int32)

Total number of pages.

Example: 1

totalElementsinteger(int64)

Total number of items across all pages.

Example: 5

lastboolean

Whether this is the last page.

Example: true

numberOfElementsinteger(int32)

Number of elements in the current page.

Example: 5

sizeinteger(int32)

Number of items per page.

Example: 10

numberinteger(int32)

Current page number (0-based).

Example: 0

sortobject(SortInfo)

Sorting information.

firstboolean

Whether this is the first page.

Example: true

emptyboolean

Whether the current page is empty.

Example: false

Response

{
  "content": [
    { … }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": { … },
    "offset": 0,
    "unpaged": false,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 5,
  "last": true,
  "numberOfElements": 5,
  "size": 10,
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "empty": false
}

Get Switch Device Models

Request

Retrieve list of available switch device models.

Query

includeHiddenboolean

Whether to include hidden device models in the response. Default is false to show only non hidden models.

Default false

No request payload

Responses

Successfully retrieved Switch device models

Body

Array [

string

]

Response

[
  "ICX7250-24P",
  "ICX7150-C12P"
]

Get Access Point Device Models

Request

Retrieve list of available access point device models.

Query

includeHiddenboolean

Whether to include hidden device models in the response. Default is false to show only non hidden models.

Default false

No request payload

Responses

Successfully retrieved AP device models

Body

Array [

string

]

Response

[
  "R650",
  "R610",
  "R670"
]