Skip to content
Overview/
/
/
Changed
Last updated

Workflow Service

GET /workflows/{workflowId}/steps/{stepId}

Retrieve Workflow Step by ID

Return Type:
  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property _links (object)

    • Added property id (object)

      The unique ID for this step.

    • Added property status (object)

      The validation status of the step.

      Enum values:

      • VALID
      • INVALID

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the step is valid.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property _links (object)

    • Added property id (object)

      The unique ID for this step.

    • Added property status (object)

      The validation status of the step.

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the step is valid.

  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

DELETE /workflows/{workflowId}/steps/{stepId}

Delete Step And Disconnect

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Deleted content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request.

  • New content type : application/vnd.ruckus.v2+json

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow is not Found.

  • New content type : application/vnd.ruckus.v2+json

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

DELETE /workflows/{workflowId}/steps/{stepId}/descendantSteps
Parameters:
  • Added: deleteSelectedStep in query
Return Type:

New response : 409 Conflict

Conflict. If the selected step is an end step, or a start step and the deleteSelectedStep parameter is true.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow is not Found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

POST /workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}

Clone Workflow Steps Into Workflow

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow not found

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflows/{workflowId}/uiConfigurations/{imageType}
Return Type:
  • Changed response : 200 OK

Success

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Bad request.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow or images not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

POST /workflows/{workflowId}/workflows

Clone Workflow

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflowActionDefinitions
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

The action definitions in a paged format.

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

POST /workflowActionDefinitions/query
Request:
  • Changed content type : application/json
  • Changed property filters (object)

    The list of filters to apply.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    The list of filters to apply.

Return Type:
  • Changed response : 400 Bad Request

Bad request, check query format.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

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

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

GET /workflowActionDefinitions/{definitionId}/requiredPriorDefinitions
Return Type:
  • Changed response : 404 Not Found

Action definition not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

POST /workflows/query

Get Current Workflows

Request:
  • Changed content type : application/json
  • Changed property filters (object)

    The list of filters to apply.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    The list of filters to apply.

Return Type:
  • Changed response : 400 Bad Request

Bad request, check query format.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

GET /workflows/{workflowId}/steps

Get All Steps

Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Not Found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

The action definitions in a paged format.

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

POST /workflows/{workflowId}/steps/query

Search and Filter Workflow Steps

Request:
  • Changed content type : application/json
  • Changed property filters (object)

    The list of filters to apply.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    The list of filters to apply.

Return Type:
  • Changed response : 400 Bad Request

Bad request, check query format.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Not Found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

POST /workflows/{workflowId}/versions/query

Get Versioned Workflows

Request:
  • Changed content type : application/json
  • Changed property filters (object)

    The list of filters to apply.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property filters (object)

    The list of filters to apply.

Return Type:
  • Changed response : 400 Bad Request

Bad request, check query format.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

GET /workflowActionDefinitions/{definitionId}
Return Type:
  • Changed response : 404 Not Found

Action definition not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

OK

  • Changed content type : application/json

    • Changed property isSplit (object)

      Indicates if this action definition supports split actions. When true, this action can be used in split steps where multiple options can be defined. Split steps enable conditional branching in workflows, allowing different user paths based on choices or evaluation results.

    • Changed property split (object)

      Indicates if this action definition supports split actions. When true, this action can be used in split steps where multiple options can be defined. Split steps enable conditional branching in workflows, allowing different user paths based on choices or evaluation results.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property isSplit (object)

      Indicates if this action definition supports split actions. When true, this action can be used in split steps where multiple options can be defined. Split steps enable conditional branching in workflows, allowing different user paths based on choices or evaluation results.

    • Changed property split (object)

      Indicates if this action definition supports split actions. When true, this action can be used in split steps where multiple options can be defined. Split steps enable conditional branching in workflows, allowing different user paths based on choices or evaluation results.

POST /workflows
Request:
  • Changed content type : application/json

  • Added property publishedChildren (object)

    Indicates that there is a published workflow that is a child of this workflow.

  • Changed property name (object)

    The name of the workflow.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property publishedChildren (object)

    Indicates that there is a published workflow that is a child of this workflow.

  • Changed property name (object)

    The name of the workflow.

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

DELETE /workflows/{workflowId}
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflows/{workflowId}
Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property publishedChildren (object)

      Indicates that there is a published workflow that is a child of this workflow.

    • Added property status (object)

      The validation status of the workflow.

      Enum values:

      • VALID
      • INVALID

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the workflow is valid.

    • Changed property name (object)

      The name of the workflow.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property publishedChildren (object)

      Indicates that there is a published workflow that is a child of this workflow.

    • Added property status (object)

      The validation status of the workflow.

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the workflow is valid.

    • Changed property name (object)

      The name of the workflow.

PATCH /workflows/{workflowId}
Request:
  • Changed content type : application/json

  • Added property publishedChildren (object)

    Indicates that there is a published workflow that is a child of this workflow.

  • Changed property name (object)

    The name of the workflow.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property publishedChildren (object)

    Indicates that there is a published workflow that is a child of this workflow.

  • Changed property name (object)

    The name of the workflow.

Return Type:
  • Changed response : 200 OK

Ok - Returned if a validation request finds no errors.

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 404 Not Found

Workflow not found

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

POST /workflows/{workflowId}/steps/{stepId}/nextSteps
Request:
  • Changed content type : application/json

New required properties:

  • enrollmentActionId
  • type

  • Added property enrollmentActionId (object)

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

  • Added property type (object)

  • Changed content type : application/vnd.ruckus.v1+json

New required properties:

  • enrollmentActionId
  • type

  • Added property enrollmentActionId (object)

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

  • Added property type (object)

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Not Found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict. If the action requested cannot be found, or if the action type does not match the type of step created.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflows/{workflowId}/steps/{stepId}/splitOptions
Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow, step, or split option is not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property paging (object)

      Pagination information for paged responses.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property paging (object)

      Pagination information for paged responses.

POST /workflows/{workflowId}/steps/{stepId}/splitOptions
Request:
  • Changed content type : application/json

New required properties:

  • optionName
  • Changed property optionName (object)

    The name of the option for this step.

  • Changed content type : application/vnd.ruckus.v1+json

New required properties:

  • optionName
  • Changed property optionName (object)

    The name of the option for this step.

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow, step, or split option is not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

DELETE /workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}
Parameters:
  • Added: includeChildren in query
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow, step, or split option is not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}
Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow, step, or split option is not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • optionName

    • Added property status (object)

      The validation status of the split option.

      Enum values:

      • VALID
      • INVALID

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the split option is valid.

    • Changed property optionName (object)

      The name of the option for this step.

  • Changed content type : application/vnd.ruckus.v1+json

    New required properties:

    • optionName

    • Added property status (object)

      The validation status of the split option.

    • Added property statusReasons (object)

      The set of reasons for an invalid status. This will be empty if the split option is valid.

    • Changed property optionName (object)

      The name of the option for this step.

POST /workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps

Creates Step Under Split Option

Request:
  • Changed content type : application/json

New required properties:

  • enrollmentActionId
  • type

  • Added property enrollmentActionId (object)

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

  • Added property type (object)

  • Changed content type : application/vnd.ruckus.v1+json

New required properties:

  • enrollmentActionId
  • type

  • Added property enrollmentActionId (object)

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

  • Added property type (object)

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow, step, or split option is not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict. When the action requested cannot be found, or the action type does not match the type of step created.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

DELETE /workflows/{workflowId}/uiConfigurations
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 404 Not Found

Workflow not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

GET /workflows/{workflowId}/uiConfigurations
Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property welcomeTitle (object)

      The welcome title for the workflow UI.

    • Changed property uiColorSchema (object)

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

    • Changed property uiStyleSchema (object)

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

      • Changed property wifi4EuNetworkId (object)

        European Wi-Fi network ID.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property welcomeTitle (object)

      The welcome title for the workflow UI.

    • Changed property uiColorSchema (object)

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

    • Changed property uiStyleSchema (object)

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

      • Changed property wifi4EuNetworkId (object)

        European Wi-Fi network ID.

POST /workflows/{workflowId}/uiConfigurations
Request:
  • Changed content type : multipart/form-data

  • Changed property uiConfiguration (object)

    The definition of the UI configuration for this workflow.

    • Changed property welcomeTitle (object)

      The welcome title for the workflow UI.

    • Changed property uiColorSchema (object)

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

    • Changed property uiStyleSchema (object)

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

      • Changed property wifi4EuNetworkId (object)

        European Wi-Fi network ID.

  • Changed content type : multipart/vnd.ruckus.v1+form-data

  • Changed property uiConfiguration (object)

    The definition of the UI configuration for this workflow.

    • Changed property welcomeTitle (object)

      The welcome title for the workflow UI.

    • Changed property uiColorSchema (object)

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

    • Changed property uiStyleSchema (object)

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

      • Changed property wifi4EuNetworkId (object)

        European Wi-Fi network ID.

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property id (object)

      Optional resource ID returned after successful processing.

    • Changed property requestId (object)

      Unique identifier for the asynchronous request.

  • Changed response : 400 Bad Request

Bad request.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 404 Not Found

Workflow not found.

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property debugMessage (object)

      Detailed debug message for troubleshooting.

    • Changed property message (object)

      Error message describing what went wrong.

    • Changed property nestedErrors (object)

      List of nested error details for validation errors.

    • Changed property status (object)

      HTTP status code of the error.

    • Changed property timestamp (object)

      Timestamp when the error occurred.

Previous page
Next page