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

Get Entitlements Assignments

Request

Path
tenantIdstringrequired
Body
required
fieldsArray of stringsunique

A list of assignment data fields to be returned.

Example: ["id","quantity"]
pageinteger(int32)

The page number to be returned, 1 based, default 1.

Example: 1
pageSizeinteger(int32)

The page number to be returned, default 20.

Example: 30
sortFieldstring

The data filed name which will be used for sorting the query result.

Enum"expirationDate""effectiveDate"
Example: "expirationDate"
sortOrderstring

The sorting order, default is ascending order.

Enum"ASC""DESC"
Example: "ASC"
filtersobject(QueryAssignmentFilters)

The query filters.

{
  "fields": [
    "id",
    "quantity"
  ],
  "page": 1,
  "pageSize": 30,
  "sortField": "expirationDate",
  "sortOrder": "ASC",
  "filters": {
    "licenseType": [ … ],
    "status": [ … ],
    "createdBy": [ … ],
    "isTrial": false
  }
}

Responses

OK

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": [
    { … }
  ]
}

Create a Self Assignment

Request

This endpoint creates a self assignment, which can be used for own accounts.

Body
required
effectiveDatestringrequired

Effective date of the entitlement assignment.

Example: "2024-01-22 15:08:10Z"
expirationDatestringrequired

Expiration date of the entitlement assignment.

Example: "2024-02-21 15:07:10Z"
quantityinteger(int32)required

Quantity of entitlements assigned.

Example: 5
licenseTypestringrequired

Type of entitlement

Example: "APSW"
trialboolean
{
  "effectiveDate": "2024-01-22 15:08:10Z",
  "expirationDate": "2024-02-21 15:07:10Z",
  "quantity": 5,
  "licenseType": "APSW",
  "trial": true
}

Responses

Created a self assignment

Body
statusstring

Status of the response.

Example: "success"
messagestring

Message providing additional details about the response.

Example: "Object created/updated successfully."
dataobject(Assignment)

Data containing assignment details.

Response
{
  "status": "success",
  "message": "Object created/updated successfully.",
  "data": {
    "id": 1234,
    "effectiveDate": "2024-01-22T15:08:10Z",
    "expirationDate": "2024-02-21T15:07:10Z",
    "quantity": 5,
    "licenseType": "APSW",
    "status": "VALID",
    "createdDate": "2024-01-16T06:06:02.776Z",
    "revokedDate": "null",
    "createdBy": "rohitmsp.ruckusone5@email.com",
    "revokedBy": "null",
    "isTrial": false
  }
}

Get Self Entitlement Assignment

Request

This endpoint retrieves entitlement assignments for own accounts.

Body
required
fieldsArray of stringsunique

A list of assignment data fields to be returned.

Example: ["id","quantity"]
pageinteger(int32)

The page number to be returned, 1 based, default 1.

Example: 1
pageSizeinteger(int32)

The page number to be returned, default 20.

Example: 30
sortFieldstring

The data filed name which will be used for sorting the query result.

Enum"expirationDate""effectiveDate"
Example: "expirationDate"
sortOrderstring

The sorting order, default is ascending order.

Enum"ASC""DESC"
Example: "ASC"
filtersobject(QueryAssignmentFilters)

The query filters.

{
  "fields": [
    "id",
    "quantity"
  ],
  "page": 1,
  "pageSize": 30,
  "sortField": "expirationDate",
  "sortOrder": "ASC",
  "filters": {
    "licenseType": [ … ],
    "status": [ … ],
    "createdBy": [ … ],
    "isTrial": false
  }
}

Responses

OK

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": [
    { … }
  ]
}

Delete Self Assignment

Request

This endpoint deletes active assignments. When a license is deleted, it is not completely removed but instead marked as revoked and cannot be used.

Path
idinteger(int64)required
No request payload

Responses

Assignment deleted successfully

Response
No content

Update a Self Assignment

Request

This endpoint updates a self assignment. Quantity and expiry date can be updated for self assignments. When updating assignments, existing assignments will be revoked and new assignments will be created with updated fields.

Path
idinteger(int64)required
Body
required
expirationDatestringrequired

Expiration date of the entitlement assignment.

Example: "2024-02-21 15:07:10Z"
quantityinteger(int32)required

Quantity of entitlements assigned.

Example: 5
validboolean
{
  "expirationDate": "2024-02-21 15:07:10Z",
  "quantity": 5,
  "valid": true
}

Responses

Assignment updated successfully

Body
statusstring

Status of the response.

Example: "success"
messagestring

Message providing additional details about the response.

Example: "Object created/updated successfully."
dataobject(Assignment)

Data containing assignment details.

Response
{
  "status": "success",
  "message": "Object created/updated successfully.",
  "data": {
    "id": 1234,
    "effectiveDate": "2024-01-22T15:08:10Z",
    "expirationDate": "2024-02-21T15:07:10Z",
    "quantity": 5,
    "licenseType": "APSW",
    "status": "VALID",
    "createdDate": "2024-01-16T06:06:02.776Z",
    "revokedDate": "null",
    "createdBy": "rohitmsp.ruckusone5@email.com",
    "revokedBy": "null",
    "isTrial": false
  }
}

AvailabilityReport

Operations

AttentionNote

Operations

UsageSetting

Operations