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

Servers

Generated server url

http://localhost:8080/

Enrollment Action API

Manages enrollment actions

Operations

Get All Enrollment Actions Across Action Types

Request

Gets all enrollment actions across action types.

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). Allowed values are name, description, actionType and version.

Example: sort=actionType,name,asc

No request payload

Responses

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
}

Create Enrollment Action Across Action Types

Request

Allows user to create various enrollment actions across action types.

Body

required

One of:

Choose appropriate request body from below to configure different action types

namestring[ 2 .. 100 ] charactersrequired

Action name.

descriptionstring[ 0 .. 1000 ] characters

Action description.

actionTypestringrequired

Action type.

Enum"AUP""DATA_PROMPT""DPSK""USER_SELECTION_SPLIT""AUTO_SELECTION_SPLIT""DISPLAY_MESSAGE""MAC_REG""CERT_TEMPLATE"

Discriminator

idstring(uuid)

Action identifier.

parentActionIdstring(uuid)

Parent action identifier.

versioninteger(int32)

Version.

titlestring[ 1 .. 100 ] charactersrequired

Title displayed during enrollment.

messageHtmlstring[ 1 .. 1000 ] charactersrequired

Message displayed to user.

bottomLabelstring[ 0 .. 1000 ] characters

Bottom label displayed to user.

checkboxDefaultStateboolean

Default state of the checkbox displayed to user.

checkboxTextstring[ 1 .. 100 ] charactersrequired

Text label of the checkbox displayed to user.

checkboxHighlightColorstring^$|^#(?:[0-9a-fA-F]{3}){1,2}$|^(?:[0-9a-fA-F]...required

Highlight colour of the checkbox displayed to user.

backButtonTextstring[ 1 .. 20 ] charactersrequired

Text on the back button displayed to user.

continueButtonTextstring[ 1 .. 20 ] charactersrequired

Text on the continue button displayed to user.

useAupFileboolean

Whether to display user policy file.

aupFileLocationstring

User policy file storage location.

aupPlainTextstring[ 0 .. 1000 ] characters

User display content.

aupFileNamestring[ 0 .. 100 ] characters

Aup file name.

{
  "name": "string",
  "description": "string",
  "actionType": "AUP",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "parentActionId": "12f46041-18d6-4f38-a710-58558c6996db",
  "version": 0
}

Responses

Accepted

Body*/*

requestIdstring

idstring(uuid)

Query Enrollment Actions Across Action Types

Request

Gets the list of enrollment actions 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.

idstring(uuid)

Action id.

namestring[ 0 .. 100 ] characters

Action name.

descriptionstring[ 0 .. 1000 ] characters

Action description.

actionTypestring

Action type.

Enum"AUP""DATA_PROMPT""DPSK""USER_SELECTION_SPLIT""AUTO_SELECTION_SPLIT""DISPLAY_MESSAGE""MAC_REG""CERT_TEMPLATE"

versionstring

Version.

parentActionIdstring(uuid)

Parent action identifier.

sortFieldsArray of strings

Sort by

Items Enum"id""name""description""actionType""version"

{
  "sortDirection": "ASC",
  "page": 0,
  "pageSize": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "actionType": "AUP",
  "version": "string",
  "parentActionId": "12f46041-18d6-4f38-a710-58558c6996db",
  "sortFields": "id"
}

Responses

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
}

Get Enrollment Action Configuration for Specific Action Identifier

Request

Gets enrollment action configuration for the requested action identifier.

Path

actionIdstringrequired

Action Id

No request payload

Responses

Body

namestring[ 2 .. 100 ] charactersrequired

Action name.

descriptionstring[ 0 .. 1000 ] characters

Action description.

actionTypestringrequired

Action type.

Enum"AUP""DATA_PROMPT""DPSK""USER_SELECTION_SPLIT""AUTO_SELECTION_SPLIT""DISPLAY_MESSAGE""MAC_REG""CERT_TEMPLATE"

idstring(uuid)

Action identifier.

parentActionIdstring(uuid)

Parent action identifier.

versioninteger(int32)

Version.

validbooleanread-only

Validity flag.

_linksobject(Links)

Response

{
  "name": "string",
  "description": "string",
  "actionType": "AUP",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "parentActionId": "12f46041-18d6-4f38-a710-58558c6996db",
  "version": 0,
  "valid": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Specific Enrollment Actions

Request

Allows the user to delete enrollment action with the given id.

Path

actionIdstring(uuid)required

Action Id

No request payload

Responses

Accepted

Body

requestIdstring

idstring(uuid)

Response

{
  "requestId": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Selectively Updates Enrollment Actions

Request

Allows the user to selectively update enrollment actions.

Path

actionIdstring(uuid)required

Action Id

Body

required

Fields in enrollment actions to edit

property name*objectadditional property

{
  "property1": {},
  "property2": {}
}

Responses

Accepted

Headers

Locationstring

Updated enrollment action

Body*/*

requestIdstring

idstring(uuid)

_linksobject(Links)

Enrollment Action Files API

Manages enrollment action files

Operations

Enrollment Action Type API

Manages enrollment actions for specific action types

Operations