Skip to content
/
Get Split Option

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

Get All Split Options

Request

Retrieves all of the split options for the split step.

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

Responses

Success

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(SplitStepOption_v1_0)

The content list of the data.

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

Creates Split Option

Request

Creates a split option for the step at the end of the list of options for the split step. All split options which are functional are processed in order, which is defined as they are created.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
Body
required
optionNamestring
enrollmentActionIdstring(uuid)required

The ID of the enrollment action to be followed in this step.

_linksobject(Links)
{
  "optionName": "string",
  "enrollmentActionId": "a76b6dde-7900-4ffb-87fb-676692f788d1",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Accepted

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

Creates Step Under Option

Request

Creates a step under the requested split option. When there is no step already mapped, the step is just created and assigned to the option. When a step is already assigned to the option, this will create this step first, and move the existing step after this one.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
optionIdstring(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"
}

Get Split Option

Request

Retrieves the split option by id.

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

Responses

Success

Body
idstring(uuid)read-only

The unique ID for this option on the workflow.

optionNamestring
enrollmentActionIdstring(uuid)required

The ID of the enrollment action to be followed in this step.

actionDefinitionIdstring(uuid)read-only

The action definition ID for this step. This is a read only attribute, and will be determined by the provided enrollment action on the create.

actionTypestringread-only

The action type assigned to this step.

nextStepIdstring(uuid)read-only

The next step for this option. This is a read only attribute.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "optionName": "string",
  "enrollmentActionId": "a76b6dde-7900-4ffb-87fb-676692f788d1",
  "actionDefinitionId": "0b16f95e-fcc6-4107-a58b-86f2fc764d01",
  "actionType": "string",
  "nextStepId": "142c7a6d-2f1c-4ddc-9f1b-2ef0d2239d82",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Split Option

Request

Deletes the requested option and all of the steps under this option.

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

Responses

Accepted

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

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