Skip to content

Manage Entitlements API (0.2.0)

The Manage Entitlements API provides endpoints to manage entitlements. You can use this API to retrieve detailed information about entitlements, usage statistics, available licenses, and expired licenses. This API helps you effectively manage your entitlements and make informed decisions about licensing. Assignments API manage entitlement assignments. You can retrieve a list of assignments, create new assignments, update existing ones, and delete individual assignments.

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
E-mail

TBD@ruckuswireless.com

Languages
Servers

https://api.devalto.ruckuswireless.com/

Entitlement

Endpoints for Managing Entitlements

Operations

Assignment

Operations

AvailabilityReport

Operations

AttentionNote

Operations

Query License Attention Notes

Request

Query license attention notes.

Query
excludeContentboolean
Default false
Body
required
sortFieldstring

Sorting field, it can be any of the fields of attention notes.

Example: "startDate"
sortOrderstring

Sorting order, default is ascending order if missing.

Enum"ASC""DESC"
Example: "DESC"
pageinteger(int32)

Page number, 1 based, default is 1 if missing.

Example: 1
pageSizeinteger(int32)

Page size, default is 20 if missing.

Example: 30
fieldsArray of stringsunique

Fields to return, all fields will be returned if missing.

Items Enum"id""type""tenantType""enabled""startDate""endDate""summary""details""createdDate""updatedDate"
Example: ["summary","details"]
filtersobject(AttentionNoteQueryFilterDto)
{
  "sortField": "startDate",
  "sortOrder": "DESC",
  "page": 1,
  "pageSize": 30,
  "fields": [
    "summary",
    "details"
  ],
  "filters": {
    "type": [ … ],
    "tenantType": [ … ],
    "status": [ … ],
    "enabled": true,
    "licenseCheck": true
  }
}

Responses

Success

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
pageSizeinteger(int32)
objectIdstring
dataArray of objects
errorsArray of objects(ErrorDto)
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "subsequentQueries": [
    { … }
  ]
}

UsageSetting

Operations