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

Action Definition

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

Operations

Query Action Definitions

Request

Returns the list of action definitions using the specified query.

Query
excludeContentboolean

Excludes all of the content and just returns the counts for this query.

Default false
Body
required
sortFieldstring

The field to use to sort on.

sortOrderstring

The sort order of the applied query.

Enum"ASC""DESC"
pageinteger(int32)>= 0

The page number to return, paging starts with 0.

pageSizeinteger(int32)[ 1 .. 2000 ]

The number of items requested on the page.

filtersobject

The list of filters to apply.

{
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 1,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

List of action definitions in a paged format. Can exclude content for just count information

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(ActionDefinition_v1_0)

The content list of the data.

Response
{
  "paging": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0
  },
  "content": [
    { … }
  ]
}

Get All Action Definitions

Request

Retrieves the complete list of action definitions with paging.

Query
sizeany

Page size

pageany

The page to retrieve (starts at zero).

sortany

The field name to sort, comma seperated from the sort order (asc or desc).

No request payload

Responses

The action definitions in a paged format.

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(ActionDefinition_v1_0)

The content list of the data.

Response
{
  "paging": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0
  },
  "content": [
    { … }
  ]
}

Get Action Definition

Request

Retrieves the requested action definition by id.

Path
definitionIdstring(uuid)required
No request payload

Responses

OK

Body
idstring(uuid)read-only

The unique ID for this action definition.

namestringread-only

The name for this action definition.

descriptionstringread-only

The description for this action definition.

localizationDescriptionIdstringread-only

The ID for localization information for this action definition.

isSplitbooleanread-only

Indicates if this action definition support split actions.

actionTypestringread-only

The action type that is mapped into the step, when a step is created.

categorystringread-only

The category for this action type.

dependencyTypestringread-only

The dependency requirement.

Enum"NONE""ONE_OF""ALL"
hasEndActionsbooleanread-only

Indicates if this action also has behavior as part of the end step.

splitboolean
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "localizationDescriptionId": "string",
  "isSplit": true,
  "actionType": "string",
  "category": "string",
  "dependencyType": "NONE",
  "hasEndActions": true,
  "split": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get Prior Required Actions

Request

Retrieves the list of required prior actions for this action.

Path
definitionIdstring(uuid)required
No request payload

Responses

OK

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(ActionDefinition_v1_0)

The content list of the data.

Response
{
  "paging": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0
  },
  "content": [
    { … }
  ]
}