Skip to content

Workflow Management API (0.0.3)

Overview

The Workflow Management REST API's allow the creation of a workflow, and steps within that workflow. Steps, and split step options must be assigned actions that are already defined through the /enrollmentActions api. Please see that API for additional information. For split steps only the action definition is to be provided, but the options require a matching action type, and must be of type split.## Rate Limit For the Workflow Management REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 100 calls can be made per second.
  • Each second 50 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/

Workflow

Manages the workflows, including create, update and delete.

Operations

Steps

Manages the steps for the workflow.

Operations

Split Options

Manages the split options for split steps in a workflow.

Operations

Enrollment UI Configuration

Manages the enrollment configuration for the workflow.

Operations

Get Workflow's UI Configuration

Request

Retrieves the UI configuration for the specified workflow.

Path
workflowIdstring(uuid)required
No request payload

Responses

Success

Body
welcomeTitlestringrequired

The welcome title for the workflow UI.

welcomeNamestring

The welcome name for the workflow UI.

uiColorSchemaobject(UiColorSchema_v1_0)

The definition of the colors to be applied to the workflow ui.

uiStyleSchemaobject(UiStyleSchema_v1_0)

The definition of the style to be applied to the workflow UI.

_linksobject(Links)
Response
{
  "welcomeTitle": "string",
  "welcomeName": "string",
  "uiColorSchema": {
    "backgroundColor": "string",
    "lineColor": "string",
    "fontColor": "string",
    "fontHeaderColor": "string",
    "headerBarBackgroundColor": "string",
    "startOverFontColor": "string",
    "buttonColor": "string",
    "buttonFontColor": "string"
  },
  "uiStyleSchema": {
    "logoImageFileName": "string",
    "backgroundImageName": "string",
    "iconImageName": "string",
    "fontName": "string",
    "logoSize": "SMALL",
    "wifi4EuNetworkId": "string",
    "disablePoweredBy": true,
    "headerFontSize": 14
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Update Workflows UI Configuration

Request

Initiates a request that will update the workflows UI configuration.

Path
workflowIdstring(uuid)required
Body
uiConfigurationobject(UiConfiguration_v1_0)required

The definition of the UI configuration for this workflow.

uiConfiguration.​welcomeTitlestringrequired

The welcome title for the workflow UI.

uiConfiguration.​welcomeNamestring

The welcome name for the workflow UI.

uiConfiguration.​uiColorSchemaobject(UiColorSchema_v1_0)

The definition of the colors to be applied to the workflow ui.

uiConfiguration.​uiStyleSchemaobject(UiStyleSchema_v1_0)

The definition of the style to be applied to the workflow UI.

uiConfiguration.​_linksobject(Links)
backgroundImagestring(binary)
logoImagestring(binary)
iconImagestring(binary)
No response example

Responses

Accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Delete UI Configuration

Request

Deletes the custom settings on the UI configuration.

Path
workflowIdstring(uuid)required
No request payload

Responses

Accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Get UI Configuration's Image

Request

Get UI configuration's image for the specified workflow and image type.

Path
workflowIdstring(uuid)required
imageTypestringrequired
Enum"backgroundImages""logoImages""IconImages"
No request payload

Responses

Success

Body
fileUrlstring

The URL of the image file.

Response
{
  "fileUrl": "string"
}

Action Definition

Manages the action definitions that can be used in workflow steps.

Operations