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

Create Step

Request

Creates a step for the workflow under the specified step.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
Body
required
actionDefinitionIdstring(uuid)

The action definition ID for this step. This is a read only attribute for steps, and will be determined by the provided enrollment action on the create. For split steps this will determine the type of options that can be added to the step.

_linksobject(Links)
{
  "actionDefinitionId": "0b16f95e-fcc6-4107-a58b-86f2fc764d01",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Accepted

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

Query All Step

Request

Retrieves all of the steps for the requested workflow based on the query criteria.

Path
workflowIdstring(uuid)required
Query
excludeContentboolean
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

Success

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of EndStep_v1_0 (object) or SplitStep_v1_0 (object) or StartStep_v1_0 (object) or Step_v1_0 (object)

The content list of the data.

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

Get All Step

Request

Retrieves the complete list of steps for the workflow with paging.

Path
workflowIdstring(uuid)required
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 EndStep_v1_0 (object) or SplitStep_v1_0 (object) or StartStep_v1_0 (object) or Step_v1_0 (object)

The content list of the data.

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

Get Step

Request

Retrieves the step within the workflow by id.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
No request payload

Responses

Success

Body
One of:

The very end step for any path on a workflow. All paths will have an end step or option.

idstring(uuid)read-only

The unique ID for this step.

_linksobject(Links)
typestringrequired

The type of step.

priorStepIdstring(uuid)read-only

The prior step in the workflow. This is a read only attribute.

splitOptionIdstring(uuid)read-only

If this step is referenced by an option, rather then the step, this is the ID. Either split option or the prior step will be provided but not both.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "_links": {
    "property1": { … },
    "property2": { … }
  },
  "type": "string",
  "priorStepId": "86e312df-767c-4b72-b8e8-d606d0858748",
  "splitOptionId": "0b15d742-babc-45f3-81e8-be9e4f01487c"
}

Delete Step

Request

Deletes the requested step and reorders the remaining steps. If this is a split, all options except the first will be removed. The step under the first option will be moved to the current step flow. Start and end steps can never be deleted.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
No request payload

Responses

Accepted

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

Delete Descendant Step

Request

Deletes all of the steps that follow this step, leaving this step as the last step and the end step as the remaining steps in the list of steps.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
No request payload

Responses

Accepted

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

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