Skip to content

Workflow Actions REST API (0.0.1)

Overview

These APIs facilitate workflow actions management. Workflow actions are added as steps during workflow configuration.

RateLimit

For the Workflow actions 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/

Enrollment Action API

Manages enrollment actions

Operations

Enrollment Action Files API

Manages enrollment action files

Operations

Enrollment Action Type API

Manages enrollment actions for specific action types

Operations

Get All Enrollment Action Configuration for Specific Action Type

Request

Gets all enrollment action configurations for a specific action type.

Path
actionTypestringrequired

Action Type

Enum"AUP""DATA_PROMPT""DPSK""USER_SELECTION_SPLIT""AUTO_SELECTION_SPLIT""DISPLAY_MESSAGE""MAC_REG""CERT_TEMPLATE"
Query
sizeinteger(int32)

Number of records in a page. Will be defaulted to 20 if not specified or found invalid.

Example: size=20
pageinteger(int32)

The page to retrieve (starts at zero). Will be defaulted to 0 if not specified or found invalid

sortstring

The field names to sort with. Comma seperated from the sort order (asc or desc).

Example: sort=name,description,asc
No request payload

Responses

Ok

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
firstboolean
lastboolean
sizeinteger(int32)
contentArray of objects(EntityModelActionDto)
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,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "numberOfElements": 0,
  "empty": true
}