Skip to content
/
Query Enrollments

Admin Enrollment REST API (0.0.1)

Overview

These APIs supports admin view of enrollments and registrations.

RateLimit

For the admin enrollment REST APIs the following will be true: Limits are applied to each property. A maximum of 60 calls can be made per second. Each second 30 calls will be returned to be used.

Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Admin Enrollment Registration API

Manages enrollment registration admin views

Operations

Admin Enrollment API

Manages enrollment admin views

Operations

Query Enrollments

Request

Gets the list of enrollments using the specified query.

Body

Search criteria and pagination details

sortDirectionstring

Sort direction.

Enum"ASC""DESC"
pageinteger(int32)

Page number. If not specified the first page will be returned.

pageSizeinteger(int32)

Number of records in a page.If not specified default page size of 20 will be applied.

workflowIdstring(uuid)

Identifier of the workflow.

enrollmentIdstring(uuid)

Identifier of the enrollment.

descriptionstring[ 0 .. 1000 ] characters

Description of the enrollment.

macAddressstring^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$|^([0-9...

Mac address of the enrolled device.

ipAddressstring(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25...

Network address of the enrolled device.

statusstring

Enrollment status.

Enum"STARTED""IN_PROGRESS""FINISHED""ABANDONED""ACTIVE""INACTIVE""REVOKED"
sortFieldsArray of strings

Sort by

Items Enum"workflowId""enrollmentId""description""macAddress""ipAddress""status"
{
  "sortDirection": "ASC",
  "page": 0,
  "pageSize": 0,
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "enrollmentId": "883e2903-3e2f-407c-ae2a-1274a4137945",
  "description": "string",
  "macAddress": "string",
  "ipAddress": "string",
  "status": "STARTED",
  "sortFields": "workflowId"
}

Responses

ok

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
firstboolean
lastboolean
sizeinteger(int32)
contentArray of objects(EntityModelEnrollmentDto)
numberinteger(int32)
sortobject(SortObject)
pageableobject(PageableObject)
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    { … }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "empty": true
}

Get Enrollments for a Specific Enrollment Identifier

Request

Gets enrollment details for the requested enrollment identifier.

Path
enrollmentIdstringrequired

Enrollment Id

No request payload

Responses

Ok

Body
workflowIdstring(uuid)

Identifier of the workflow.

enrollmentIdstring(uuid)

Identifier of the enrollment.

descriptionstring[ 0 .. 1000 ] characters

Description of the enrollment.

macAddressstring^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$|^([0-9...

Mac address of the enrolled device.

ipAddressstring(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25...

Network address of the enrolled device.

statusstring

Enrollment status.

Enum"STARTED""IN_PROGRESS""FINISHED""ABANDONED""ACTIVE""INACTIVE""REVOKED"
userAgentNamestring

User agent name.

variablesArray of objects(EnrollmentVariableDto)

Enrollment variables.

_linksobject(Links)
Response
{
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "enrollmentId": "883e2903-3e2f-407c-ae2a-1274a4137945",
  "description": "string",
  "macAddress": "string",
  "ipAddress": "string",
  "status": "STARTED",
  "userAgentName": "string",
  "variables": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}