{"items":[{"type":"link","label":"Workflow Management API","link":"/api/workflow-api-0.0.4_1","routeSlug":"/api/workflow-api-0.0.4_1","content":{"contentType":"overview","meta":{"name":"Workflow Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download PDF","url":"https://docs.ruckus.cloud/static/api/workflow-api-0.0.4_1.pdf"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://support.ruckuswireless.com","url":"https://support.ruckuswireless.com"},{"kind":"email","title":"RUCKUS One Support","email":"support@ruckuswireless.com","label":"support@ruckuswireless.com","withCopyButton":true,"copyContent":"support@ruckuswireless.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"RUCKUS Cloud Privacy Policy","url":"https://support.ruckuswireless.com/ruckus-one-privacy-policy"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Workflow Management API (0.0.4)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api/workflow-api-0.0.4_1"}],"sectionId":"/api/workflow-api-0.0.4_1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Workflow Management REST APIs allow the creation of a workflow, and steps within the workflow. Steps, and split step options must be assigned actions that are already defined through the Enrollment Actions 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."},"children":[]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/getting-started:-creating-workflows-and-steps"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started: Creating Workflows and Steps"},"children":[]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/getting-started:-creating-workflows-and-steps"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/getting-started:-creating-workflows-and-steps"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/1.-create-a-workflow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Create a Workflow"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /workflows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with required fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowedIps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disAllowedIps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for network restrictions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The workflow will be created with a status of work in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /workflows/{workflowId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update workflow properties"},"children":[]}]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/1.-create-a-workflow"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/1.-create-a-workflow"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/2.-create-steps"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Create Steps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Steps define the user journey within a workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start Step"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /workflows/{workflowId}/steps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create the initial step"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular Steps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create additional steps using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /workflows/{workflowId}/steps/{stepId}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Steps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create branching logic using split steps with multiple options"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End Steps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Mark steps as terminating to end the workflow"},"children":[]}]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/2.-create-steps"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/2.-create-steps"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/3.-assign-actions-to-steps"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Assign Actions to Steps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each step requires an action definition:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query available actions using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /workflowActionDefinitions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign action by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actionDefinitionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the step"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For split steps, create options using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /workflows/{workflowId}/steps/{stepId}/splitOptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each split option must have a matching action type"},"children":[]}]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/3.-assign-actions-to-steps"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/3.-assign-actions-to-steps"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/4.-connect-steps-in-sequence"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Connect Steps in Sequence"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link steps together to create the workflow flow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextStepId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to connect steps in sequence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to attach steps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For split steps, each option can lead to different next steps"},"children":[]}]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/4.-connect-steps-in-sequence"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/4.-connect-steps-in-sequence"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/5.-publish-the-workflow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5. Publish the Workflow"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make the workflow available to users:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /workflows/{workflowId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publishedDetails.status: 'PUBLISHED'"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The workflow must be valid before publishing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Published workflows can be assigned to captive portal networks"},"children":[]}]}]}]}]}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/5.-publish-the-workflow"}],"sectionId":"/api/workflow-api-0.0.4_1/section/overview/5.-publish-the-workflow"}]}]}},{"type":"group","label":"Overview","link":"/api/workflow-api-0.0.4_1/section/overview","routeSlug":"/api/workflow-api-0.0.4_1/section/overview","items":[{"type":"link","label":"Getting Started: Creating Workflows and Steps","link":"/api/workflow-api-0.0.4_1/section/overview/getting-started:-creating-workflows-and-steps","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/getting-started:-creating-workflows-and-steps","content":null},{"type":"link","label":"1. Create a Workflow","link":"/api/workflow-api-0.0.4_1/section/overview/1.-create-a-workflow","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/1.-create-a-workflow","content":null},{"type":"link","label":"2. Create Steps","link":"/api/workflow-api-0.0.4_1/section/overview/2.-create-steps","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/2.-create-steps","content":null},{"type":"link","label":"3. Assign Actions to Steps","link":"/api/workflow-api-0.0.4_1/section/overview/3.-assign-actions-to-steps","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/3.-assign-actions-to-steps","content":null},{"type":"link","label":"4. Connect Steps in Sequence","link":"/api/workflow-api-0.0.4_1/section/overview/4.-connect-steps-in-sequence","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/4.-connect-steps-in-sequence","content":null},{"type":"link","label":"5. Publish the Workflow","link":"/api/workflow-api-0.0.4_1/section/overview/5.-publish-the-workflow","routeSlug":"/api/workflow-api-0.0.4_1/section/overview/5.-publish-the-workflow","content":null}],"content":null},{"type":"group","label":"Workflow","link":"/api/workflow-api-0.0.4_1/workflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow","items":[{"label":"Reference Split Option to Another Workflow","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/referencesplitoptiontoworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/referencesplitoptiontoworkflow","metadata":{"seo":{"title":"Reference Split Option to Another Workflow","description":"Creates an external workflow reference step after the specified split option in a workflow. This links a branch path to another workflow by reference without cloning its steps. The workflow cannot reference itself and the referenced workflow must exist, contain more than the default start/end steps, and must not have disconnected steps; only single level references are supported (the parent cannot already be referenced by another workflow, and the referenced workflow cannot contain its own references); the same referenced workflow can only be added once to a parent workflow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"referenceSplitOptionToWorkflow","name":"Reference Split Option to Another Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps~1workflows~1{referencedWorkflowId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference Split Option to Another Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an external workflow reference step after the specified split option in a workflow. This links a branch path to another workflow by reference without cloning its steps. The workflow cannot reference itself and the referenced workflow must exist, contain more than the default start/end steps, and must not have disconnected steps; only single level references are supported (the parent cannot already be referenced by another workflow, and the referenced workflow cannot contain its own references); the same referenced workflow can only be added once to a parent workflow."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"optionId","in":"path","schemaId":"schema_519","required":true},{"name":"referencedWorkflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps~1workflows~1{referencedWorkflowId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps/workflows/{referencedWorkflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"optionId","in":"path","required":true,"schemaId":"schema_519"},{"name":"referencedWorkflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps/workflows/{referencedWorkflowId}","href":"workflow/referencesplitoptiontoworkflow","openApiOperationId":"referenceSplitOptionToWorkflow","summary":"Reference Split Option to Another Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps~1workflows~1{referencedWorkflowId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps/workflows/{referencedWorkflowId}"},{"label":"Reference Step to Another Workflow","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/referencesteptoworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/referencesteptoworkflow","metadata":{"seo":{"title":"Reference Step to Another Workflow","description":"Creates an external workflow reference step after the specified step in a workflow. The referenced workflow is linked by reference only; its steps are not copied into the parent workflow. The workflow cannot reference itself and the referenced workflow must exist, contain more than the default start/end steps, and must not have disconnected steps; only single level references are supported (the parent cannot already be referenced by another workflow, and the referenced workflow cannot contain its own references); the same referenced workflow can only be added once to a parent workflow; the parent step must exist and cannot be an end step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"referenceStepToWorkflow","name":"Reference Step to Another Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference Step to Another Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an external workflow reference step after the specified step in a workflow. The referenced workflow is linked by reference only; its steps are not copied into the parent workflow. The workflow cannot reference itself and the referenced workflow must exist, contain more than the default start/end steps, and must not have disconnected steps; only single level references are supported (the parent cannot already be referenced by another workflow, and the referenced workflow cannot contain its own references); the same referenced workflow can only be added once to a parent workflow; the parent step must exist and cannot be an end step."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"referencedWorkflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"referencedWorkflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","href":"workflow/referencesteptoworkflow","openApiOperationId":"referenceStepToWorkflow","summary":"Reference Step to Another Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}"},{"label":"Clone Workflow Steps Into Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/nestedcloneworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/nestedcloneworkflow","metadata":{"seo":{"title":"Clone Workflow Steps Into Workflow","description":"Imports an existing workflow as a nested workflow within the current workflow, creating a hierarchical workflow structure. This operation clones the referenced workflow and inserts all of that workflows' steps after the specified step in the current workflow. The imported workflow becomes a nested component that can be executed as part of the parent workflow's flow. This enables workflow composition and reuse, allowing complex workflows to be built from smaller, reusable workflow components. The operation requires both workflows to exist and be different, and the referenced workflow must have more than just default steps. The operation is asynchronous and returns a request ID for tracking the import process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"nestedCloneWorkflow","name":"Clone Workflow Steps Into Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone Workflow Steps Into Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Imports an existing workflow as a nested workflow within the current workflow, creating a hierarchical workflow structure. This operation clones the referenced workflow and inserts all of that workflows' steps after the specified step in the current workflow. The imported workflow becomes a nested component that can be executed as part of the parent workflow's flow. This enables workflow composition and reuse, allowing complex workflows to be built from smaller, reusable workflow components. The operation requires both workflows to exist and be different, and the referenced workflow must have more than just default steps. The operation is asynchronous and returns a request ID for tracking the import process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"referencedWorkflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"referencedWorkflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","href":"workflow/nestedcloneworkflow","openApiOperationId":"nestedCloneWorkflow","summary":"Clone Workflow Steps Into Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1workflows~1{referencedWorkflowId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}"},{"label":"Create Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/createworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/createworkflow","metadata":{"seo":{"title":"Create Workflow","description":"Creates a new workflow with the specified configuration and automatically initializes it with start and end steps. This operation accepts a workflow data object containing the workflow name, description, network restrictions (allowedIps/disAllowedIps), and publication details. The workflow is created in 'WORK_IN_PROGRESS' status by default, and start/end steps are automatically generated. The operation is asynchronous and returns a request ID for tracking the creation process. Required fields include 'name' (workflow name), while 'description', 'allowedIps', 'disAllowedIps', and 'publishedDetails' are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWorkflow","name":"Create Workflow","isWebhook":false,"pointer":"/paths/~1workflows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new workflow with the specified configuration and automatically initializes it with start and end steps. This operation accepts a workflow data object containing the workflow name, description, network restrictions (allowedIps/disAllowedIps), and publication details. The workflow is created in 'WORK_IN_PROGRESS' status by default, and start/end steps are automatically generated. The operation is asynchronous and returns a request ID for tracking the creation process. Required fields include 'name' (workflow name), while 'description', 'allowedIps', 'disAllowedIps', and 'publishedDetails' are optional."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"schemaId":"components/schemas/Workflow_v1_0","pointer":"/paths/~1workflows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"responseCodes":["202","400","409"],"pointer":"/workflows","href":"workflow/createworkflow","openApiOperationId":"createWorkflow","summary":"Create Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/Workflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows"},{"label":"Clone Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/cloneworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/cloneworkflow","metadata":{"seo":{"title":"Clone Workflow","description":"Creates a complete copy of an existing workflow including all its steps, split options, and configuration. The cloned workflow will have a new unique ID and a name generated by appending 'Clone' to the original workflow name (with incremental numbering if duplicates exist). The cloned workflow is created in 'WORK_IN_PROGRESS' status regardless of the source workflow's status. This operation requires the source workflow to have more than just the default start/end steps. The operation is asynchronous and returns a request ID for tracking the cloning process. The cloned workflow can be independently modified and published."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloneWorkflow","name":"Clone Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1workflows/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a complete copy of an existing workflow including all its steps, split options, and configuration. The cloned workflow will have a new unique ID and a name generated by appending 'Clone' to the original workflow name (with incremental numbering if duplicates exist). The cloned workflow is created in 'WORK_IN_PROGRESS' status regardless of the source workflow's status. This operation requires the source workflow to have more than just the default start/end steps. The operation is asynchronous and returns a request ID for tracking the cloning process. The cloned workflow can be independently modified and published."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/workflows","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","409"],"pointer":"/workflows/{workflowId}/workflows","href":"workflow/cloneworkflow","openApiOperationId":"cloneWorkflow","summary":"Clone Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/workflows"},{"label":"Get Versioned Workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/queryforversionedworkflows","routeSlug":"/api/workflow-api-0.0.4_1/workflow/queryforversionedworkflows","metadata":{"seo":{"title":"Get Versioned Workflows","description":"Retrieves all published versions of a specific workflow, including the original workflow and all its published iterations. This endpoint returns a paginated list of workflow versions that share the same parent workflow ID, allowing you to track the evolution of a workflow over time. Each version includes publication details such as version number, publication status, and publication date. Use the QueryData parameter to filter, sort, and paginate through the version history. The excludeContent parameter can be used to retrieve only the total count without the full workflow details for performance optimization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryForVersionedWorkflows","name":"Get Versioned Workflows","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1versions~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Versioned Workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all published versions of a specific workflow, including the original workflow and all its published iterations. This endpoint returns a paginated list of workflow versions that share the same parent workflow ID, allowing you to track the evolution of a workflow over time. Each version includes publication details such as version number, publication status, and publication date. Use the QueryData parameter to filter, sort, and paginate through the version history. The excludeContent parameter can be used to retrieve only the total count without the full workflow details for performance optimization."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1versions~1query/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1{workflowId}~1versions~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1workflows~1{workflowId}~1versions~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/versions/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/versions/query","href":"workflow/queryforversionedworkflows","openApiOperationId":"queryForVersionedWorkflows","summary":"Get Versioned Workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},{"code":"400","description":"Bad request, check query format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1versions~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/versions/query"},{"label":"Get Referencing Workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/queryforreferencingworkflows","routeSlug":"/api/workflow-api-0.0.4_1/workflow/queryforreferencingworkflows","metadata":{"seo":{"title":"Get Referencing Workflows","description":"Retrieves workflows that reference the specified workflow as an external workflow reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryForReferencingWorkflows","name":"Get Referencing Workflows","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1referencedWorkflows~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Referencing Workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves workflows that reference the specified workflow as an external workflow reference."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1referencedWorkflows~1query/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1{workflowId}~1referencedWorkflows~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1workflows~1{workflowId}~1referencedWorkflows~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/referencedWorkflows/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/referencedWorkflows/query","href":"workflow/queryforreferencingworkflows","openApiOperationId":"queryForReferencingWorkflows","summary":"Get Referencing Workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},{"code":"400","description":"Bad request, check query format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1referencedWorkflows~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/referencedWorkflows/query"},{"label":"Get Current Workflows","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/queryforworkflows","routeSlug":"/api/workflow-api-0.0.4_1/workflow/queryforworkflows","metadata":{"seo":{"title":"Get Current Workflows","description":"Retrieves all of the work in progress workflows based on the query criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryForWorkflows","name":"Get Current Workflows","isWebhook":false,"pointer":"/paths/~1workflows~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Current Workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all of the work in progress workflows based on the query criteria."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1workflows~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/workflows/query","href":"workflow/queryforworkflows","openApiOperationId":"queryForWorkflows","summary":"Get Current Workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},{"code":"400","description":"Bad request, check query format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceWorkflow_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/query"},{"label":"Get Workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/getworkflowbyid","routeSlug":"/api/workflow-api-0.0.4_1/workflow/getworkflowbyid","metadata":{"seo":{"title":"Get Workflow","description":"Retrieves the requested workflow by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowById","name":"Get Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the requested workflow by id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","description":"Workflow identifier.","required":true}],"pointer":"/paths/~1workflows~1{workflowId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}","href":"workflow/getworkflowbyid","openApiOperationId":"getWorkflowById","summary":"Get Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"schemaId":"components/schemas/Workflow_v1_0"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Workflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}"},{"label":"Delete Workflow","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/deleteworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/deleteworkflow","metadata":{"seo":{"title":"Delete Workflow","description":"Initiates a request that will delete the workflow requested. If the workflow id provided is for a workflow that is in a work in progress state then it will be deleted along with all dependent published and retired workflows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWorkflow","name":"Delete Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a request that will delete the workflow requested. If the workflow id provided is for a workflow that is in a work in progress state then it will be deleted along with all dependent published and retired workflows."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","409"],"pointer":"/workflows/{workflowId}","href":"workflow/deleteworkflow","openApiOperationId":"deleteWorkflow","summary":"Delete Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}"},{"label":"Update a Workflow","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/workflow/updateworkflow","routeSlug":"/api/workflow-api-0.0.4_1/workflow/updateworkflow","metadata":{"seo":{"title":"Update a Workflow","description":"Updates an existing workflow with new configuration values including name, description, network restrictions (allowedIps/disAllowedIps), and publication status. This operation supports partial updates where only provided fields are modified. The workflow can be updated in 'WORK_IN_PROGRESS' status, and publication status can be changed to 'VALIDATE' (for validation only) or 'PUBLISHED' (to publish the workflow). Once published, a workflow cannot be modified except for publication status changes. The operation validates the workflow before publishing and returns appropriate status codes based on the operation type. This operation is asynchronous and returns a request ID for tracking the update process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWorkflow","name":"Update a Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing workflow with new configuration values including name, description, network restrictions (allowedIps/disAllowedIps), and publication status. This operation supports partial updates where only provided fields are modified. The workflow can be updated in 'WORK_IN_PROGRESS' status, and publication status can be changed to 'VALIDATE' (for validation only) or 'PUBLISHED' (to publish the workflow). Once published, a workflow cannot be modified except for publication status changes. The operation validates the workflow before publishing and returns appropriate status codes based on the operation type. This operation is asynchronous and returns a request ID for tracking the update process."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"schemaId":"components/schemas/Workflow_v1_0","pointer":"/paths/~1workflows~1{workflowId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workflows/{workflowId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"responseCodes":["200","202","404","409"],"pointer":"/workflows/{workflowId}","href":"workflow/updateworkflow","openApiOperationId":"updateWorkflow","summary":"Update a Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/Workflow_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Workflow_v1_0"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok - Returned if a validation request finds no errors.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"404","description":" Workflow not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}"}],"content":{"contentType":"group","meta":{"name":"Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow","showPageActions":true},{"nodeType":"markdoc","content":"Manages the workflows, including create, update and delete."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps/workflows/{referencedWorkflowId}","summary":"Reference Split Option to Another Workflow","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow/referencesplitoptiontoworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","summary":"Reference Step to Another Workflow","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workflow/referencesteptoworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/nextSteps/workflows/{referencedWorkflowId}","summary":"Clone Workflow Steps Into Workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/nestedcloneworkflow","deprecated":false},{"title":"/workflows","summary":"Create Workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/createworkflow","deprecated":false},{"title":"/workflows/{workflowId}/workflows","summary":"Clone Workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/cloneworkflow","deprecated":false},{"title":"/workflows/{workflowId}/versions/query","summary":"Get Versioned Workflows","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/queryforversionedworkflows","deprecated":false},{"title":"/workflows/{workflowId}/referencedWorkflows/query","summary":"Get Referencing Workflows","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/queryforreferencingworkflows","deprecated":false},{"title":"/workflows/query","summary":"Get Current Workflows","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workflow/queryforworkflows","deprecated":false},{"title":"/workflows/{workflowId}","summary":"Get Workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/getworkflowbyid","deprecated":false},{"title":"/workflows/{workflowId}","summary":"Delete Workflow","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workflow/deleteworkflow","deprecated":false},{"title":"/workflows/{workflowId}","summary":"Update a Workflow","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/workflow/updateworkflow","deprecated":false}]}]}]}]}},{"type":"group","label":"Steps","link":"/api/workflow-api-0.0.4_1/steps","routeSlug":"/api/workflow-api-0.0.4_1/steps","items":[{"label":"Attach Step To Referenced Workflow","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/attachstepstoreferenceworkflow","routeSlug":"/api/workflow-api-0.0.4_1/steps/attachstepstoreferenceworkflow","metadata":{"seo":{"title":"Attach Step To Referenced Workflow","description":"Attach an existing detached step after the end step of a referenced workflow. Use workflowId for the parent workflow, referencedWorkflowId for the nested referenced workflow, refWorkflowEndStep for the referenced workflow end step anchor, and detachedStepId for the step to connect. The detached step must not already have a prior step, cannot be a start or end step, and cannot create circular dependencies. The refWorkflowEndStep must belong to the referenced workflow. This operation is asynchronous and returns a request ID for tracking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachStepsToReferenceWorkflow","name":"Attach Step To Referenced Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps~1{detachedStepId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach Step To Referenced Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attach an existing detached step after the end step of a referenced workflow. Use workflowId for the parent workflow, referencedWorkflowId for the nested referenced workflow, refWorkflowEndStep for the referenced workflow end step anchor, and detachedStepId for the step to connect. The detached step must not already have a prior step, cannot be a start or end step, and cannot create circular dependencies. The refWorkflowEndStep must belong to the referenced workflow.  This operation is asynchronous and returns a request ID for tracking."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","description":"Referenced workflow ID","required":true},{"name":"referencedWorkflowId","in":"path","schemaId":"schema_519","description":"The referenced workflow ID that this attached step belongs to.","required":true},{"name":"refWorkflowEndStep","in":"path","schemaId":"schema_519","description":"The end step ID of referenced workflow under which the step will be attached.","required":true},{"name":"detachedStepId","in":"path","schemaId":"schema_519","description":"The step ID that will be attached below the step.","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps~1{detachedStepId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps/{detachedStepId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"referencedWorkflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"refWorkflowEndStep","in":"path","required":true,"schemaId":"schema_519"},{"name":"detachedStepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps/{detachedStepId}","href":"steps/attachstepstoreferenceworkflow","openApiOperationId":"attachStepsToReferenceWorkflow","summary":"Attach Step To Referenced Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. If either of the steps involved in attachment are of the wrong type or cannot be found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps~1{detachedStepId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps/{detachedStepId}"},{"label":"Attach Step","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/attachsteps","routeSlug":"/api/workflow-api-0.0.4_1/steps/attachsteps","metadata":{"seo":{"title":"Attach Step","description":"Attach a detached step to an existing step in the workflow. This operation takes a step that is currently disconnected from the workflow flow and connects it as the next step after the specified parent step. The detached step must not already have a prior step, cannot be a start or end step, and cannot create circular dependencies. This operation is asynchronous and returns a request ID for tracking the attachment process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachSteps","name":"Attach Step","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1{detachedStepId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach Step","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attach a detached step to an existing step in the workflow. This operation takes a step that is currently disconnected from the workflow flow and connects it as the next step after the specified parent step. The detached step must not already have a prior step, cannot be a start or end step, and cannot create circular dependencies. This operation is asynchronous and returns a request ID for tracking the attachment process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","description":"Workflow ID","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","description":"The step ID under which the step will be attached.","required":true},{"name":"detachedStepId","in":"path","schemaId":"schema_519","description":"The step ID that will be attached below the step.","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1{detachedStepId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"detachedStepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}","href":"steps/attachsteps","openApiOperationId":"attachSteps","summary":"Attach Step"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. If either of the steps involved in attachment are of the wrong type or cannot be found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps~1{detachedStepId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}"},{"label":"Create Step To Referenced Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/createchildsteptoreferencedworkflow","routeSlug":"/api/workflow-api-0.0.4_1/steps/createchildsteptoreferencedworkflow","metadata":{"seo":{"title":"Create Step To Referenced Workflow","description":"Creates a new step that continues the flow after the end step of a referenced workflow within a parent workflow. Use workflowId to identify the parent workflow being edited and referencedWorkflowId to identify the nested referenced workflow whose branch is being extended. The refWorkflowEndStep must be an end step that belongs to the referenced workflow; only end steps of a referenced workflow may have following steps. The request body defines the new step type and action definition, which must be valid for the referenced workflow context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChildStepToReferencedWorkflow","name":"Create Step To Referenced Workflow","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Step To Referenced Workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new step that continues the flow after the end step of a referenced workflow within a parent workflow. Use workflowId to identify the parent workflow being edited and referencedWorkflowId to identify the nested referenced workflow whose branch is being extended. The refWorkflowEndStep must be an end step that belongs to the referenced workflow; only end steps of a referenced workflow may have following steps. The request body defines the new step type and action definition, which must be valid for the referenced workflow context."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"referencedWorkflowId","in":"path","schemaId":"schema_519","required":true},{"name":"refWorkflowEndStep","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"schemaId":"components/schemas/AbstractActionStepDto","pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"referencedWorkflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"refWorkflowEndStep","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps","href":"steps/createchildsteptoreferencedworkflow","openApiOperationId":"createChildStepToReferencedWorkflow","summary":"Create Step To Referenced Workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/AbstractActionStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. If the action requested cannot be found, or if the action type does not match the type of step created.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1workflows~1{referencedWorkflowId}~1endSteps~1{refWorkflowEndStep}~1nextSteps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps"},{"label":"Create Step","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/createchildstep","routeSlug":"/api/workflow-api-0.0.4_1/steps/createchildstep","metadata":{"seo":{"title":"Create Step","description":"Creates a new step in the workflow that will be executed after the specified parent step. This operation allows you to add sequential steps to the workflow flow, including regular steps, split steps, or other step types. The new step requires a valid action definition that matches the step type being created, and will be automatically connected to the parent step in the workflow sequence. The operation validates that the parent step exists and is not an end step, and ensures the action type matches the step type. This operation is asynchronous and returns a request ID for tracking the creation process. The new step can be further configured with additional steps or split options as needed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChildStep","name":"Create Step","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Step","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new step in the workflow that will be executed after the specified parent step. This operation allows you to add sequential steps to the workflow flow, including regular steps, split steps, or other step types. The new step requires a valid action definition that matches the step type being created, and will be automatically connected to the parent step in the workflow sequence. The operation validates that the parent step exists and is not an end step, and ensures the action type matches the step type. This operation is asynchronous and returns a request ID for tracking the creation process. The new step can be further configured with additional steps or split options as needed."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"schemaId":"components/schemas/AbstractActionStepDto","pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/steps/{stepId}/nextSteps","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/nextSteps","href":"steps/createchildstep","openApiOperationId":"createChildStep","summary":"Create Step"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/AbstractActionStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. If the action requested cannot be found, or if the action type does not match the type of step created.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1nextSteps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/nextSteps"},{"label":"Search and Filter Workflow Steps","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/queryforstepsassignedtothisworkflow","routeSlug":"/api/workflow-api-0.0.4_1/steps/queryforstepsassignedtothisworkflow","metadata":{"seo":{"title":"Search and Filter Workflow Steps","description":"Searches and retrieves workflow steps using advanced query criteria. This endpoint supports complex filtering by step properties (ID, action definition, step type, termination status), custom sorting by multiple fields, and pagination controls. The query accepts a QueryData object containing filter conditions, sort specifications, and pagination parameters. Use the excludeContent parameter to retrieve only the total count without step details for performance optimization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryForStepsAssignedToThisWorkflow","name":"Search and Filter Workflow Steps","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search and Filter Workflow Steps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches and retrieves workflow steps using advanced query criteria. This endpoint supports complex filtering by step properties (ID, action definition, step type, termination status), custom sorting by multiple fields, and pagination controls. The query accepts a QueryData object containing filter conditions, sort specifications, and pagination parameters. Use the excludeContent parameter to retrieve only the total count without step details for performance optimization."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1query/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1workflows~1{workflowId}~1steps~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/steps/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/steps/query","href":"steps/queryforstepsassignedtothisworkflow","openApiOperationId":"queryForStepsAssignedToThisWorkflow","summary":"Search and Filter Workflow Steps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"}},"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},{"code":"400","description":"Bad request, check query format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/query"},{"label":"Get All Steps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/getallstepsforworkflow","routeSlug":"/api/workflow-api-0.0.4_1/steps/getallstepsforworkflow","metadata":{"seo":{"title":"Get All Steps","description":"Retrieves the complete list of steps for the workflow with paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllStepsForWorkflow","name":"Get All Steps","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Steps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the complete list of steps for the workflow with paging."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_521","description":"Page size"},{"name":"page","in":"query","schemaId":"schema_521","description":"The page to retrieve (starts at zero)."},{"name":"sort","in":"query","schemaId":"schema_521","description":"The field name to sort, comma separated from the sort order (asc or desc)."}],"pointer":"/paths/~1workflows~1{workflowId}~1steps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/steps","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"size","in":"query"},{"name":"page","in":"query"},{"name":"sort","in":"query"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/steps","href":"steps/getallstepsforworkflow","openApiOperationId":"getAllStepsForWorkflow","summary":"Get All Steps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The action definitions in a paged format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"}},"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceAbstractBaseStepDto"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps"},{"label":"Retrieve Workflow Step by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/getstepbyid","routeSlug":"/api/workflow-api-0.0.4_1/steps/getstepbyid","metadata":{"seo":{"title":"Retrieve Workflow Step by ID","description":"Retrieves detailed information about a specific workflow step by its unique identifier. Returns complete step data including step type, action definitions, navigation relationships (prior/next steps), split options, termination status, and enrollment actions. This operation requires both workflowId and stepId parameters to locate the step within the correct workflow context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStepById","name":"Retrieve Workflow Step by ID","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Workflow Step by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific workflow step by its unique identifier. Returns complete step data including step type, action definitions, navigation relationships (prior/next steps), split options, termination status, and enrollment actions. This operation requires both workflowId and stepId parameters to locate the step within the correct workflow context."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/steps/{stepId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}","href":"steps/getstepbyid","openApiOperationId":"getStepById","summary":"Retrieve Workflow Step by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractBaseStepDto"}},"schemaId":"components/schemas/AbstractBaseStepDto"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AbstractBaseStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AbstractBaseStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractBaseStepDto"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}"},{"label":"Delete Step And Disconnect","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/deletestepv2","routeSlug":"/api/workflow-api-0.0.4_1/steps/deletestepv2","metadata":{"seo":{"title":"Delete Step And Disconnect","description":"Deletes the requested step and leaves the previous and next steps disconnected. 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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStepV2","name":"Delete Step And Disconnect","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Step And Disconnect","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the requested step and leaves the previous and next steps disconnected. 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."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflowId}/steps/{stepId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}","href":"steps/deletestepv2","openApiOperationId":"deleteStepV2","summary":"Delete Step And Disconnect"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/vnd.ruckus.v1+json","mediaTypes":["application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/vnd.ruckus.v1+json","mediaTypes":["application/vnd.ruckus.v1+json","application/json","application/vnd.ruckus.v2+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v2+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Workflow is not Found.","mediaType":"application/vnd.ruckus.v1+json","mediaTypes":["application/vnd.ruckus.v1+json","application/json","application/vnd.ruckus.v2+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v2+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/vnd.ruckus.v1+json","application/json","application/vnd.ruckus.v2+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v2+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/vnd.ruckus.v1+json","application/json","application/vnd.ruckus.v2+json"],"mediaTypeContent":{"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v2+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}"},{"label":"Delete Descendant Step","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/steps/deletedescendantsteps","routeSlug":"/api/workflow-api-0.0.4_1/steps/deletedescendantsteps","metadata":{"seo":{"title":"Delete Descendant Step","description":"Deletes all steps that are descendants of the specified step, effectively truncating the workflow at that point. This operation removes all steps that follow the specified step in the workflow sequence, making the specified step the final step in the workflow flow. The operation supports an optional parameter to also delete the selected step itself. This is useful for removing entire branches of a workflow or cleaning up workflow sections. The operation cannot be performed on end steps (as they have no descendants) or start steps (when deleteSelectedStep is true). This operation is asynchronous and returns a request ID for tracking the deletion process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDescendantSteps","name":"Delete Descendant Step","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1descendantSteps/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Descendant Step","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes all steps that are descendants of the specified step, effectively truncating the workflow at that point. This operation removes all steps that follow the specified step in the workflow sequence, making the specified step the final step in the workflow flow. The operation supports an optional parameter to also delete the selected step itself. This is useful for removing entire branches of a workflow or cleaning up workflow sections. The operation cannot be performed on end steps (as they have no descendants) or start steps (when deleteSelectedStep is true). This operation is asynchronous and returns a request ID for tracking the deletion process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1descendantSteps/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleteSelectedStep","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1descendantSteps/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflowId}/steps/{stepId}/descendantSteps","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"deleteSelectedStep","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/descendantSteps","href":"steps/deletedescendantsteps","openApiOperationId":"deleteDescendantSteps","summary":"Delete Descendant Step"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Workflow is not Found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. If the selected step is an end step, or a start step and the deleteSelectedStep parameter is true.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1descendantSteps/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/descendantSteps"}],"content":{"contentType":"group","meta":{"name":"Steps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Steps","showPageActions":true},{"nodeType":"markdoc","content":"Manages the steps for the workflow."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps/{detachedStepId}","summary":"Attach Step To Referenced Workflow","prefix":{"name":"put","color":"put"},"badges":[],"link":"/steps/attachstepstoreferenceworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}","summary":"Attach Step","prefix":{"name":"put","color":"put"},"badges":[],"link":"/steps/attachsteps","deprecated":false},{"title":"/workflows/{workflowId}/workflows/{referencedWorkflowId}/endSteps/{refWorkflowEndStep}/nextSteps","summary":"Create Step To Referenced Workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/steps/createchildsteptoreferencedworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/nextSteps","summary":"Create Step","prefix":{"name":"post","color":"post"},"badges":[],"link":"/steps/createchildstep","deprecated":false},{"title":"/workflows/{workflowId}/steps/query","summary":"Search and Filter Workflow Steps","prefix":{"name":"post","color":"post"},"badges":[],"link":"/steps/queryforstepsassignedtothisworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps","summary":"Get All Steps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/steps/getallstepsforworkflow","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}","summary":"Retrieve Workflow Step by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/steps/getstepbyid","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}","summary":"Delete Step And Disconnect","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/steps/deletestepv2","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/descendantSteps","summary":"Delete Descendant Step","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/steps/deletedescendantsteps","deprecated":false}]}]}]}]}},{"type":"group","label":"Split Options","link":"/api/workflow-api-0.0.4_1/split-options","routeSlug":"/api/workflow-api-0.0.4_1/split-options","items":[{"label":"Get All Split Options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/split-options/getallsplitstepoptionsforstep","routeSlug":"/api/workflow-api-0.0.4_1/split-options/getallsplitstepoptionsforstep","metadata":{"seo":{"title":"Get All Split Options","description":"Retrieves all of the split options for the split step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllSplitStepOptionsForStep","name":"Get All Split Options","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Split Options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all of the split options for the split step."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions","href":"split-options/getallsplitstepoptionsforstep","openApiOperationId":"getAllSplitStepOptionsForStep","summary":"Get All Split Options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow, step, or split option is not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceSplitStepOption_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions"},{"label":"Creates Split Option","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/split-options/createoption","routeSlug":"/api/workflow-api-0.0.4_1/split-options/createoption","metadata":{"seo":{"title":"Creates Split Option","description":"Creates a new split option for a split step, defining a branching path in the workflow. A split option represents a conditional branch that users can take based on the evaluation of an enrollment action. The new option is automatically added to the end of the existing options list and will be processed in the order they were created. Each split option requires a unique name within the split step and must reference a valid enrollment action that matches the split step's action type. The operation is asynchronous and returns a request ID for tracking the creation process. Split options enable conditional workflow branching where different user paths can lead to different subsequent steps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOption","name":"Creates Split Option","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates Split Option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new split option for a split step, defining a branching path in the workflow. A split option represents a conditional branch that users can take based on the evaluation of an enrollment action. The new option is automatically added to the end of the existing options list and will be processed in the order they were created. Each split option requires a unique name within the split step and must reference a valid enrollment action that matches the split step's action type. The operation is asynchronous and returns a request ID for tracking the creation process. Split options enable conditional workflow branching where different user paths can lead to different subsequent steps."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/SplitStepOption_v1_0"}},"schemaId":"components/schemas/SplitStepOption_v1_0","pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/SplitStepOption_v1_0"}},"responseCodes":["202","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions","href":"split-options/createoption","openApiOperationId":"createOption","summary":"Creates Split Option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/SplitStepOption_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/SplitStepOption_v1_0"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow, step, or split option is not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions"},{"label":"Creates Step Under Split Option","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/split-options/createnextstepforoption","routeSlug":"/api/workflow-api-0.0.4_1/split-options/createnextstepforoption","metadata":{"seo":{"title":"Creates Step Under Split Option","description":"Creates a new step that will be executed when a specific split option is selected by the user. This operation allows you to define the workflow path that follows a particular split option. If no step is currently assigned to the option, the new step becomes the immediate next step for that option. If a step already exists for the option, the new step is inserted before the existing step, creating a sequential flow. The operation requires a valid action definition that matches the step type being created. This enables complex branching workflows where different split option choices lead to different sequences of steps. The operation is asynchronous and returns a request ID for tracking the creation process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNextStepForOption","name":"Creates Step Under Split Option","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates Step Under Split Option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new step that will be executed when a specific split option is selected by the user. This operation allows you to define the workflow path that follows a particular split option. If no step is currently assigned to the option, the new step becomes the immediate next step for that option. If a step already exists for the option, the new step is inserted before the existing step, creating a sequential flow. The operation requires a valid action definition that matches the step type being created. This enables complex branching workflows where different split option choices lead to different sequences of steps. The operation is asynchronous and returns a request ID for tracking the creation process."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"optionId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"schemaId":"components/schemas/AbstractActionStepDto","pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"optionId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps","href":"split-options/createnextstepforoption","openApiOperationId":"createNextStepForOption","summary":"Creates Step Under Split Option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/AbstractActionStepDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AbstractActionStepDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AbstractActionStepDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow, step, or split option is not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict. When the action requested cannot be found, or the action type does not match the type of step created.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}~1nextSteps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps"},{"label":"Get Split Option","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/split-options/getsplitstepoptionbyid","routeSlug":"/api/workflow-api-0.0.4_1/split-options/getsplitstepoptionbyid","metadata":{"seo":{"title":"Get Split Option","description":"Retrieves the split option by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSplitStepOptionById","name":"Get Split Option","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Split Option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the split option by id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"optionId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"optionId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","href":"split-options/getsplitstepoptionbyid","openApiOperationId":"getSplitStepOptionById","summary":"Get Split Option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/SplitStepOption_v1_0"}},"schemaId":"components/schemas/SplitStepOption_v1_0"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow, step, or split option is not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SplitStepOption_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplitStepOption_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/SplitStepOption_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}"},{"label":"Delete Split Option","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/split-options/deletesplitoption","routeSlug":"/api/workflow-api-0.0.4_1/split-options/deletesplitoption","metadata":{"seo":{"title":"Delete Split Option","description":"Deletes the requested option and all of the steps under this option."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSplitOption","name":"Delete Split Option","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Split Option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the requested option and all of the steps under this option."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"stepId","in":"path","schemaId":"schema_519","required":true},{"name":"optionId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeChildren","in":"query","schemaId":"schema_520"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_519"},{"name":"optionId","in":"path","required":true,"schemaId":"schema_519"}],"query":[{"name":"includeChildren","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","404"],"pointer":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","href":"split-options/deletesplitoption","openApiOperationId":"deleteSplitOption","summary":"Delete Split Option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow, step, or split option is not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1steps~1{stepId}~1splitOptions~1{optionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}"}],"content":{"contentType":"group","meta":{"name":"Split Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Split Options","showPageActions":true},{"nodeType":"markdoc","content":"Manages the split options for split steps in a workflow."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions","summary":"Get All Split Options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/split-options/getallsplitstepoptionsforstep","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions","summary":"Creates Split Option","prefix":{"name":"post","color":"post"},"badges":[],"link":"/split-options/createoption","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}/nextSteps","summary":"Creates Step Under Split Option","prefix":{"name":"post","color":"post"},"badges":[],"link":"/split-options/createnextstepforoption","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","summary":"Get Split Option","prefix":{"name":"get","color":"get"},"badges":[],"link":"/split-options/getsplitstepoptionbyid","deprecated":false},{"title":"/workflows/{workflowId}/steps/{stepId}/splitOptions/{optionId}","summary":"Delete Split Option","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/split-options/deletesplitoption","deprecated":false}]}]}]}]}},{"type":"group","label":"Enrollment UI Configuration","link":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration","routeSlug":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration","items":[{"label":"Get Workflow's UI Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/getuiconfiguration","routeSlug":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/getuiconfiguration","metadata":{"seo":{"title":"Get Workflow's UI Configuration","description":"Retrieves the UI configuration for the specified workflow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUiConfiguration","name":"Get Workflow's UI Configuration","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Workflow's UI Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the UI configuration for the specified workflow."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/uiConfigurations","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/uiConfigurations","href":"enrollment-ui-configuration/getuiconfiguration","openApiOperationId":"getUiConfiguration","summary":"Get Workflow's UI Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UiConfiguration_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/UiConfiguration_v1_0"}},"schemaId":"components/schemas/UiConfiguration_v1_0"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UiConfiguration_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UiConfiguration_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/UiConfiguration_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/uiConfigurations"},{"label":"Update Workflows UI Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/createuiconfig","routeSlug":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/createuiconfig","metadata":{"seo":{"title":"Update Workflows UI Configuration","description":"Initiates a request that will update the workflows UI configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUiConfig","name":"Update Workflows UI Configuration","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Workflows UI Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a request that will update the workflows UI configuration."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data","multipart/vnd.ruckus.v1+form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_522"},"multipart/vnd.ruckus.v1+form-data":{"schemaId":"schema_522"}},"schemaId":"schema_522","pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflows/{workflowId}/uiConfigurations","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_522"},"multipart/vnd.ruckus.v1+form-data":{"schemaId":"schema_522"}},"responseCodes":["202","400","404","409"],"pointer":"/workflows/{workflowId}/uiConfigurations","href":"enrollment-ui-configuration/createuiconfig","openApiOperationId":"createUiConfig","summary":"Update Workflows UI Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_522","mediaTypes":["multipart/form-data","multipart/vnd.ruckus.v1+form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_522"},"multipart/vnd.ruckus.v1+form-data":{"schemaId":"schema_522"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/uiConfigurations"},{"label":"Delete UI Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/resetuiconfig","routeSlug":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/resetuiconfig","metadata":{"seo":{"title":"Delete UI Configuration","description":"Deletes the custom settings on the UI configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resetUiConfig","name":"Delete UI Configuration","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete UI Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the custom settings on the UI configuration."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workflows/{workflowId}/uiConfigurations","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","404","409"],"pointer":"/workflows/{workflowId}/uiConfigurations","href":"enrollment-ui-configuration/resetuiconfig","openApiOperationId":"resetUiConfig","summary":"Delete UI Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}},"schemaId":"components/schemas/AsyncRequestResponse"},{"code":"404","description":" Workflow not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AsyncRequestResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AsyncRequestResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AsyncRequestResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/uiConfigurations"},{"label":"Get UI Configuration's Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/getimagefile","routeSlug":"/api/workflow-api-0.0.4_1/enrollment-ui-configuration/getimagefile","metadata":{"seo":{"title":"Get UI Configuration's Image","description":"Get UI configuration's image for the specified workflow and image type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getImageFile","name":"Get UI Configuration's Image","isWebhook":false,"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations~1{imageType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get UI Configuration's Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get UI configuration's image for the specified workflow and image type."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowId","in":"path","schemaId":"schema_519","required":true},{"name":"imageType","in":"path","schemaId":"schema_523","required":true}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations~1{imageType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflows/{workflowId}/uiConfigurations/{imageType}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"workflowId","in":"path","required":true,"schemaId":"schema_519"},{"name":"imageType","in":"path","required":true,"schemaId":"schema_523"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/workflows/{workflowId}/uiConfigurations/{imageType}","href":"enrollment-ui-configuration/getimagefile","openApiOperationId":"getImageFile","summary":"Get UI Configuration's Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UiConfigImage_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/UiConfigImage_v1_0"}},"schemaId":"components/schemas/UiConfigImage_v1_0"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":" Workflow or images not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflows~1{workflowId}~1uiConfigurations~1{imageType}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UiConfigImage_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UiConfigImage_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/UiConfigImage_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflows/{workflowId}/uiConfigurations/{imageType}"}],"content":{"contentType":"group","meta":{"name":"Enrollment UI Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrollment UI Configuration","showPageActions":true},{"nodeType":"markdoc","content":"Manages the enrollment configuration for the workflow."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflows/{workflowId}/uiConfigurations","summary":"Get Workflow's UI Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enrollment-ui-configuration/getuiconfiguration","deprecated":false},{"title":"/workflows/{workflowId}/uiConfigurations","summary":"Update Workflows UI Configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/enrollment-ui-configuration/createuiconfig","deprecated":false},{"title":"/workflows/{workflowId}/uiConfigurations","summary":"Delete UI Configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/enrollment-ui-configuration/resetuiconfig","deprecated":false},{"title":"/workflows/{workflowId}/uiConfigurations/{imageType}","summary":"Get UI Configuration's Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enrollment-ui-configuration/getimagefile","deprecated":false}]}]}]}]}},{"type":"group","label":"Action Definition","link":"/api/workflow-api-0.0.4_1/action-definition","routeSlug":"/api/workflow-api-0.0.4_1/action-definition","items":[{"label":"Query Action Definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/action-definition/queryforactiondefinitions","routeSlug":"/api/workflow-api-0.0.4_1/action-definition/queryforactiondefinitions","metadata":{"seo":{"title":"Query Action Definitions","description":"Returns the list of action definitions using the specified query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryForActionDefinitions","name":"Query Action Definitions","isWebhook":false,"pointer":"/paths/~1workflowActionDefinitions~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Action Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of action definitions using the specified query."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_520","description":"Excludes all of the content and just returns the counts for this query."}],"pointer":"/paths/~1workflowActionDefinitions~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1workflowActionDefinitions~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflowActionDefinitions/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_520"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/workflowActionDefinitions/query","href":"action-definition/queryforactiondefinitions","openApiOperationId":"queryForActionDefinitions","summary":"Query Action Definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of action definitions in a paged format. Can exclude content for just count information","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},{"code":"400","description":"Bad request, check query format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflowActionDefinitions~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflowActionDefinitions/query"},{"label":"Get All Action Definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/action-definition/getallactions","routeSlug":"/api/workflow-api-0.0.4_1/action-definition/getallactions","metadata":{"seo":{"title":"Get All Action Definitions","description":"Retrieves the complete list of action definitions with paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllActions","name":"Get All Action Definitions","isWebhook":false,"pointer":"/paths/~1workflowActionDefinitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Action Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the complete list of action definitions with paging."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_521","description":"Page size"},{"name":"page","in":"query","schemaId":"schema_521","description":"The page to retrieve (starts at zero)."},{"name":"sort","in":"query","schemaId":"schema_521","description":"The field name to sort, comma separated from the sort order (asc or desc)."}],"pointer":"/paths/~1workflowActionDefinitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflowActionDefinitions","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"size","in":"query"},{"name":"page","in":"query"},{"name":"sort","in":"query"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/workflowActionDefinitions","href":"action-definition/getallactions","openApiOperationId":"getAllActions","summary":"Get All Action Definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The action definitions in a paged format.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},{"code":"400","description":"Invalid id supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflowActionDefinitions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflowActionDefinitions"},{"label":"Get Action Definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/action-definition/getbydefinitionid","routeSlug":"/api/workflow-api-0.0.4_1/action-definition/getbydefinitionid","metadata":{"seo":{"title":"Get Action Definition","description":"Retrieves the requested action definition by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getByDefinitionId","name":"Get Action Definition","isWebhook":false,"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Action Definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the requested action definition by id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"definitionId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflowActionDefinitions/{definitionId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"definitionId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/workflowActionDefinitions/{definitionId}","href":"action-definition/getbydefinitionid","openApiOperationId":"getByDefinitionId","summary":"Get Action Definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ActionDefinition_v1_0"}},"schemaId":"components/schemas/ActionDefinition_v1_0"},{"code":"404","description":" Action definition not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActionDefinition_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ActionDefinition_v1_0"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflowActionDefinitions/{definitionId}"},{"label":"Get Prior Required Actions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/workflow-api-0.0.4_1/action-definition/getrequiredpriordefinitions","routeSlug":"/api/workflow-api-0.0.4_1/action-definition/getrequiredpriordefinitions","metadata":{"seo":{"title":"Get Prior Required Actions","description":"Retrieves the list of required prior actions for this action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequiredPriorDefinitions","name":"Get Prior Required Actions","isWebhook":false,"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}~1requiredPriorDefinitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Prior Required Actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of required prior actions for this action."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"definitionId","in":"path","schemaId":"schema_519","required":true}],"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}~1requiredPriorDefinitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workflowActionDefinitions/{definitionId}/requiredPriorDefinitions","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"definitionId","in":"path","required":true,"schemaId":"schema_519"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/workflowActionDefinitions/{definitionId}/requiredPriorDefinitions","href":"action-definition/getrequiredpriordefinitions","openApiOperationId":"getRequiredPriorDefinitions","summary":"Get Prior Required Actions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}},"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},{"code":"404","description":" Action definition not found.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1workflowActionDefinitions~1{definitionId}~1requiredPriorDefinitions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PagedResponseResourceActionDefinition_v1_0"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/workflowActionDefinitions/{definitionId}/requiredPriorDefinitions"}],"content":{"contentType":"group","meta":{"name":"Action Definition"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Action Definition","showPageActions":true},{"nodeType":"markdoc","content":"Manages the action definitions that can be used in workflow steps."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflowActionDefinitions/query","summary":"Query Action Definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/action-definition/queryforactiondefinitions","deprecated":false},{"title":"/workflowActionDefinitions","summary":"Get All Action Definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-definition/getallactions","deprecated":false},{"title":"/workflowActionDefinitions/{definitionId}","summary":"Get Action Definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-definition/getbydefinitionid","deprecated":false},{"title":"/workflowActionDefinitions/{definitionId}/requiredPriorDefinitions","summary":"Get Prior Required Actions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/action-definition/getrequiredpriordefinitions","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ErrorResource":{"id":"components/schemas/ErrorResource","kind":"json-schema","title":"ErrorResource","data":{"type":"object","description":"Standard error response containing error details, validation errors, and debugging information.","properties":{"requestId":{"type":"string","description":"Unique identifier for the request that generated this error."},"status":{"type":"string","description":"HTTP status code of the error response.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the error occurred."},"message":{"type":"string","description":"Human-readable error message for end users."},"debugMessage":{"type":"string","description":"Detailed error message for debugging purposes."},"nestedErrors":{"type":"array","description":"List of validation errors and constraint violations.","items":{"$ref":"#/components/schemas/RestErrorDetails"}},"errors":{"type":"array","description":"List of user friendly error messages with codes and suggestions.","items":{"$ref":"#/components/schemas/UxNestedError"}}}}},"components/schemas/RestErrorDetails":{"id":"components/schemas/RestErrorDetails","kind":"json-schema","title":"RestErrorDetails","data":{"description":"Base class for error details containing common error information."}},"components/schemas/UxNestedError":{"id":"components/schemas/UxNestedError","kind":"json-schema","title":"UxNestedError","data":{"type":"object","description":"User friendly error message with code, message, reason, and optional suggestion.","properties":{"code":{"type":"string","description":"Error code identifier for programmatic error handling."},"message":{"type":"string","description":"Human-readable error message for end users."},"reason":{"type":"string","description":"Explanation of why the error occurred."},"suggestion":{"type":"string","description":"Optional suggestion for resolving the error."}}}},"components/schemas/AsyncRequestResponse":{"id":"components/schemas/AsyncRequestResponse","kind":"json-schema","title":"AsyncRequestResponse","data":{"type":"object","description":"Asynchronous request response containing request ID and optional resource ID.","properties":{"requestId":{"type":"string","description":"Unique identifier for the asynchronous request."},"id":{"type":"string","description":"Optional resource ID returned after successful processing."}}}},"components/schemas/PublishedDetails_v1_0":{"id":"components/schemas/PublishedDetails_v1_0","kind":"json-schema","title":"PublishedDetails_v1_0","data":{"type":"object","description":"The publish details for the workflow.","properties":{"parentWorkflowId":{"type":"string","format":"uuid","description":"The unique ID for the work in progress parent workflow of this version of the workflow.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version number.","readOnly":true},"publishedDate":{"type":"string","format":"date-time","description":"The date that this workflow was published. Not supported with filtering.","readOnly":true},"status":{"type":"string","description":"The current publication status of the workflow.","enum":["WORK_IN_PROGRESS","PUBLISHED","RETIRED","VALIDATE"]}},"required":["status"]}},"components/schemas/WorkflowStatusReasonDto_v1_0":{"id":"components/schemas/WorkflowStatusReasonDto_v1_0","kind":"json-schema","title":"WorkflowStatusReasonDto_v1_0","data":{"type":"object","description":"The validation status of a workflow.","properties":{"statusCode":{"type":"string","description":"A string code for a specific validation reason that can be used for internationalization."},"statusReason":{"type":"string","description":"An string explaining the validation error."}}}},"components/schemas/Workflow_v1_0":{"id":"components/schemas/Workflow_v1_0","kind":"json-schema","title":"Workflow_v1_0","data":{"type":"object","description":"A workflow represents a sequence of steps that define the user journey to register their device, or devices. Workflows contain steps that can be executed in order, with support for branching logic through split steps. Each workflow has a start step, optional intermediate steps, and end steps that define the complete process flow.A workflow must be published to make the portal available to users. The workflow can be assigned to captive portal networks.","properties":{"id":{"type":"string","format":"uuid","description":"The unique ID for this workflow.","readOnly":true},"name":{"type":"string","description":"The name of the workflow.","minLength":1},"description":{"type":"string","description":"The description of a workflow."},"allowedIps":{"type":"array","description":"The list of IP addresses that are permitted to access this workflow. Only one allowed IP can be queried for using filter in the query data.","items":{"type":"string"}},"disAllowedIps":{"type":"array","description":"The list of IP addresses that are not permitted to access this workflow. Only one not allowed IP can be queried for using filter in the query data.","items":{"type":"string"}},"publishedDetails":{"$ref":"#/components/schemas/PublishedDetails_v1_0","description":"This is the publication details for the workflow.  The only change here that will be recognized on a PATCH, is a request to change the publication state of this workflow. A status of 'validate' will validate the current workflow and return an error if it cannot be published, if no errors are found then no change will occur."},"startStepId":{"type":"string","format":"uuid","description":"The start step for this workflow."},"publishedChildren":{"type":"boolean","description":"Indicates that there is a published workflow that is a child of this workflow."},"status":{"type":"string","description":"The validation status of the workflow.","enum":["VALID","INVALID"],"readOnly":true},"statusReasons":{"type":"array","description":"The set of reasons for an invalid status. This will be empty if the workflow is valid.","items":{"$ref":"#/components/schemas/WorkflowStatusReasonDto_v1_0"},"readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"required":["name"]}},"components/schemas/AbstractActionStepDto":{"id":"components/schemas/AbstractActionStepDto","kind":"json-schema","title":"AbstractActionStepDto","data":{"type":"object","description":"Abstract base class for action step data transfer objects containing common action step properties.","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/Step_v1_0"},{"$ref":"#/components/schemas/SplitStep_v1_0"}],"properties":{"id":{"type":"string","format":"uuid","description":"The unique ID for this step.","readOnly":true},"status":{"type":"string","description":"The validation status of the step.","enum":["VALID","INVALID"],"readOnly":true},"statusReasons":{"type":"array","description":"The set of reasons for an invalid status. This will be empty if the step is valid.","items":{"$ref":"#/components/schemas/StepStatusReasonDto_v1_0"},"readOnly":true,"uniqueItems":true},"actionDefinitionId":{"type":"string","format":"uuid","description":"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."},"actionType":{"type":"string","description":"The action type assigned to this step.","readOnly":true},"priorStepId":{"type":"string","format":"uuid","description":"The prior step in the workflow. This is a read only attribute.","readOnly":true},"splitOptionId":{"type":"string","format":"uuid","description":"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.","readOnly":true},"enrollmentActionId":{"type":"string","format":"uuid","description":"The ID of the enrollment action to be followed in this step."},"label":{"type":"string","description":"The label for this step. This is an optional field. If provided, it must not be empty and cannot exceed 32 characters.","maxLength":32,"minLength":0},"_links":{"$ref":"#/components/schemas/Links"},"type":{"type":"string"}},"required":["enrollmentActionId","type"]}},"components/schemas/SplitOptionStatusReasonDto_v1_0":{"id":"components/schemas/SplitOptionStatusReasonDto_v1_0","kind":"json-schema","title":"SplitOptionStatusReasonDto_v1_0","data":{"type":"object","description":"The validation status of a split option.","properties":{"statusCode":{"type":"string","description":"A string code for a specific validation reason that can be used for internationalization."},"statusReason":{"type":"string","description":"An string explaining the validation error."}}}},"components/schemas/SplitStepOption_v1_0":{"id":"components/schemas/SplitStepOption_v1_0","kind":"json-schema","title":"SplitStepOption_v1_0","data":{"type":"object","description":"A option assigned to the split step which defines the action to use when evaluating this option, and the next step if the action evaluates true. Creating one will always add it to the end of the list, and the options will always be processed in order.","properties":{"id":{"type":"string","format":"uuid","description":"The unique ID for this option on the workflow.","readOnly":true},"optionName":{"type":"string","description":"The name of the option for this step.","minLength":1},"enrollmentActionId":{"type":"string","format":"uuid","description":"The ID of the enrollment action to be followed in this step."},"actionDefinitionId":{"type":"string","format":"uuid","description":"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.","readOnly":true},"actionType":{"type":"string","description":"The action type assigned to this step.","readOnly":true},"nextStepId":{"type":"string","format":"uuid","description":"The next step for this option. This is a read only attribute.","readOnly":true},"status":{"type":"string","description":"The validation status of the split option.","enum":["VALID","INVALID"],"readOnly":true},"statusReasons":{"type":"array","description":"The set of reasons for an invalid status. This will be empty if the split option is valid.","items":{"$ref":"#/components/schemas/SplitOptionStatusReasonDto_v1_0"},"readOnly":true,"uniqueItems":true},"_links":{"$ref":"#/components/schemas/Links"}},"required":["enrollmentActionId","optionName"]}},"components/schemas/SplitStep_v1_0":{"id":"components/schemas/SplitStep_v1_0","kind":"json-schema","title":"SplitStep_v1_0","data":{"allOf":[{"$ref":"#/components/schemas/AbstractActionStepDto"},{"type":"object","properties":{"type":{"type":"string","description":"The type of step."},"firstSplitOption":{"$ref":"#/components/schemas/SplitStepOption_v1_0","description":"The split option to be created when this split step is created. It can be any kind of step defined in the option and will created if provided on the POST, but will be ignored on a PATCH."},"splitOptionsList":{"type":"array","description":"The split options that are assigned to this step.","items":{"$ref":"#/components/schemas/SplitStepOption_v1_0"},"readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}}],"description":"A split step within the workflow that enables conditional branching based on user choices or evaluation results. Split steps contain multiple split options, each representing a different path the user can take. When a split step is executed, the system evaluates the conditions for each split option in order and routes the user to the appropriate path based on the first matching condition. Split steps are essential for creating complex workflows with decision points, allowing different user journeys based on their responses, device characteristics, or other criteria. Each split option must have a unique name and reference a valid enrollment action that matches the split step's action type.","discriminator":{"propertyName":"type"},"required":[]}},"components/schemas/StepStatusReasonDto_v1_0":{"id":"components/schemas/StepStatusReasonDto_v1_0","kind":"json-schema","title":"StepStatusReasonDto_v1_0","data":{"type":"object","description":"The validation status of a step.","properties":{"statusCode":{"type":"string","description":"A string code for a specific validation reason that can be used for internationalization."},"statusReason":{"type":"string","description":"An string explaining the validation error."}}}},"components/schemas/Step_v1_0":{"id":"components/schemas/Step_v1_0","kind":"json-schema","title":"Step_v1_0","data":{"allOf":[{"$ref":"#/components/schemas/AbstractActionStepDto"},{"type":"object","properties":{"type":{"type":"string","description":"The type of step."},"nextStepId":{"type":"string","format":"uuid","description":"The next step in the workflow. This is a read only attribute.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}}],"description":"A step within the workflow.","discriminator":{"propertyName":"type"},"required":[]}},"components/schemas/QueryData":{"id":"components/schemas/QueryData","kind":"json-schema","title":"QueryData","data":{"type":"object","description":"Query data allows the consumer to define paging, sorting, and filtering operations.","properties":{"sortField":{"type":"string","description":"The field to use to sort on."},"sortOrder":{"type":"string","description":"The sort order of the applied query.","enum":["ASC","DESC"]},"page":{"type":"integer","format":"int32","description":"The page number to return, paging starts with 0.","minimum":0},"pageSize":{"type":"integer","format":"int32","description":"The number of items requested on the page.","maximum":2000,"minimum":1},"filters":{"type":"object","additionalProperties":{},"description":"The list of filters to apply."}}}},"components/schemas/PageDto":{"id":"components/schemas/PageDto","kind":"json-schema","title":"PageDto","data":{"type":"object","description":"Pagination information for paged responses.","properties":{"totalCount":{"type":"integer","format":"int64","description":"The total count of items."},"page":{"type":"integer","format":"int32","description":"The page number requested, starting with 0."},"pageSize":{"type":"integer","format":"int32","description":"The number of items on this page."},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages available."}}}},"components/schemas/PagedResponseResourceWorkflow_v1_0":{"id":"components/schemas/PagedResponseResourceWorkflow_v1_0","kind":"json-schema","title":"PagedResponseResourceWorkflow_v1_0","data":{"type":"object","description":"Generic paged response containing pagination information and content list.","properties":{"paging":{"$ref":"#/components/schemas/PageDto","description":"The paging information for this response."},"content":{"type":"array","description":"The content list of the data.","items":{"$ref":"#/components/schemas/Workflow_v1_0"}}}}},"components/schemas/UiColorSchema_v1_0":{"id":"components/schemas/UiColorSchema_v1_0","kind":"json-schema","title":"UiColorSchema_v1_0","data":{"type":"object","description":"The definition of the colors to be applied to the workflow UI.","properties":{"backgroundColor":{"type":"string","description":"Color for the UI background.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"lineColor":{"type":"string","description":"Color for the UI lines.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"fontColor":{"type":"string","description":"Color for the UI fonts.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"fontHeaderColor":{"type":"string","description":"Color for the header fonts.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"headerBarBackgroundColor":{"type":"string","description":"Background color for the header bar.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"startOverFontColor":{"type":"string","description":"Font color for the start over button.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"buttonColor":{"type":"string","description":"Color for the UI buttons.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"},"buttonFontColor":{"type":"string","description":"Font color for the UI buttons.","pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"}}}},"components/schemas/UiConfiguration_v1_0":{"id":"components/schemas/UiConfiguration_v1_0","kind":"json-schema","title":"UiConfiguration_v1_0","data":{"type":"object","description":"The definition of the UI configuration for this workflow.","properties":{"welcomeTitle":{"type":"string","description":"The welcome title for the workflow UI.","minLength":1},"welcomeName":{"type":"string","description":"The welcome name for the workflow UI."},"uiColorSchema":{"$ref":"#/components/schemas/UiColorSchema_v1_0","description":"The UI color schema."},"uiStyleSchema":{"$ref":"#/components/schemas/UiStyleSchema_v1_0","description":"The UI style schema."},"_links":{"$ref":"#/components/schemas/Links"}},"required":["welcomeTitle"]}},"components/schemas/UiStyleSchema_v1_0":{"id":"components/schemas/UiStyleSchema_v1_0","kind":"json-schema","title":"UiStyleSchema_v1_0","data":{"type":"object","description":"The definition of the style to be applied to the workflow UI.","properties":{"logoImageFileName":{"type":"string","description":"The image ID of the logo file to use in the UI."},"backgroundImageName":{"type":"string","description":"The image ID of the background file to use in the UI."},"iconImageName":{"type":"string","description":"The image ID of the icon file to use in the UI."},"fontName":{"type":"string","description":"The name of the font to use in the UI."},"wifi4EuNetworkId":{"type":"string","description":"European Wi-Fi network ID."},"logoSize":{"type":"string","description":"The size of the logo to display.","enum":["SMALL","MEDIUM","LARGE"]},"disablePoweredBy":{"type":"boolean","description":"Indicates if the powered by RUCKUS note will show on the UI."},"headerFontSize":{"type":"integer","format":"int32","description":"The font size of the header to display.","maximum":18,"minimum":14}}}},"components/schemas/AbstractBaseStepDto":{"id":"components/schemas/AbstractBaseStepDto","kind":"json-schema","title":"AbstractBaseStepDto","data":{"type":"object","description":"Abstract base class for workflow step data transfer objects containing common step properties.","properties":{"id":{"type":"string","format":"uuid","description":"The unique ID for this step.","readOnly":true},"status":{"type":"string","description":"The validation status of the step.","enum":["VALID","INVALID"],"readOnly":true},"statusReasons":{"type":"array","description":"The set of reasons for an invalid status. This will be empty if the step is valid.","items":{"$ref":"#/components/schemas/StepStatusReasonDto_v1_0"},"readOnly":true,"uniqueItems":true},"_links":{"$ref":"#/components/schemas/Links"}}}},"components/schemas/PagedResponseResourceAbstractBaseStepDto":{"id":"components/schemas/PagedResponseResourceAbstractBaseStepDto","kind":"json-schema","title":"PagedResponseResourceAbstractBaseStepDto","data":{"type":"object","description":"Generic paged response containing pagination information and content list.","properties":{"paging":{"$ref":"#/components/schemas/PageDto","description":"The paging information for this response."},"content":{"type":"array","description":"The content list of the data.","items":{"$ref":"#/components/schemas/AbstractBaseStepDto"}}}}},"components/schemas/ActionDefinition_v1_0":{"id":"components/schemas/ActionDefinition_v1_0","kind":"json-schema","title":"ActionDefinition_v1_0","data":{"type":"object","description":"The list of actions that can be assigned to a step.","properties":{"id":{"type":"string","format":"uuid","description":"The unique ID for this action definition.","readOnly":true},"name":{"type":"string","description":"The name for this action definition.","readOnly":true},"description":{"type":"string","description":"The description for this action definition.","readOnly":true},"localizationDescriptionId":{"type":"string","description":"The ID for localization information for this action definition.","readOnly":true},"isSplit":{"type":"boolean","description":"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.","readOnly":true},"split":{"type":"boolean","description":"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.","readOnly":true},"actionType":{"type":"string","description":"The action type that is mapped into the step, when a step is created.","readOnly":true},"category":{"type":"string","description":"The category for this action type.","readOnly":true},"hasEndActions":{"type":"boolean","description":"Indicates if this action also has behavior as part of the end step.","readOnly":true},"dependencyType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The dependency requirement type for prerequisite actions. Indicates whether the step requires no dependent actions (NONE), one matching prerequisite action (ONE_OF), or all prerequisite actions (ALL)."},"children":[]}]}]}],"enum":["NONE","ONE_OF","ALL"],"readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}}}},"components/schemas/PagedResponseResourceActionDefinition_v1_0":{"id":"components/schemas/PagedResponseResourceActionDefinition_v1_0","kind":"json-schema","title":"PagedResponseResourceActionDefinition_v1_0","data":{"type":"object","description":"Generic paged response containing pagination information and content list.","properties":{"paging":{"$ref":"#/components/schemas/PageDto","description":"The paging information for this response."},"content":{"type":"array","description":"The content list of the data.","items":{"$ref":"#/components/schemas/ActionDefinition_v1_0"}}}}},"components/schemas/UiConfigImage_v1_0":{"id":"components/schemas/UiConfigImage_v1_0","kind":"json-schema","title":"UiConfigImage_v1_0","data":{"type":"object","description":"Defines an image resource used in the workflow user interface, including logos, background images, and icons. This schema specifies the file URL where the image is stored and can be referenced by the UI configuration. Images are used to customize the visual appearance of the workflow portal, providing branding elements and visual context for users during the device registration process. The image file must be accessible via the provided URL and should be in a standard web compatible format such as PNG, JPEG, or SVG.","properties":{"fileUrl":{"type":"string","description":"The URL of the image file."}}}},"components/schemas/PagedResponseResourceSplitStepOption_v1_0":{"id":"components/schemas/PagedResponseResourceSplitStepOption_v1_0","kind":"json-schema","title":"PagedResponseResourceSplitStepOption_v1_0","data":{"type":"object","description":"Generic paged response containing pagination information and content list.","properties":{"paging":{"$ref":"#/components/schemas/PageDto","description":"The paging information for this response."},"content":{"type":"array","description":"The content list of the data.","items":{"$ref":"#/components/schemas/SplitStepOption_v1_0"}}}}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}}},"components/schemas/Links":{"id":"components/schemas/Links","kind":"json-schema","title":"Links","data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}}},"schema_519":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"object","properties":{"uiConfiguration":{"$ref":"#/components/schemas/UiConfiguration_v1_0"},"backgroundImage":{"type":"string","format":"binary"},"logoImage":{"type":"string","format":"binary"},"iconImage":{"type":"string","format":"binary"}},"required":["uiConfiguration"]},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"type":"string","enum":["backgroundImages","logoImages","IconImages"]},"id":"schema_523"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}]},"options":{"hideReplay":true,"hideDownloadButtons":false,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"downloadUrls":[{"title":"Download PDF","url":"https://docs.ruckus.cloud/static/api/workflow-api-0.0.4_1.pdf"}],"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true,"position":"off"},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Workflow Management API","description":"# Overview\n\nThe Workflow Management REST APIs allow the creation of a workflow, and steps within the workflow. Steps, and split step options must be assigned actions that are already defined through the Enrollment Actions 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.\n\n## Getting Started: Creating Workflows and Steps\n\n### 1. Create a Workflow\nTo create a new workflow:\n1. Use `POST /workflows` with required fields: `name`, `description`\n2. Optionally specify `allowedIps` and `disAllowedIps` for network restrictions\n3. The workflow will be created with a status of work in progress\n4. Use `PATCH /workflows/{workflowId}` to update workflow properties\n\n### 2. Create Steps\nSteps define the user journey within a workflow:\n1. **Start Step**: Use `POST /workflows/{workflowId}/steps` to create the initial step\n2. **Regular Steps**: Create additional steps using `POST /workflows/{workflowId}/steps/{stepId}`\n3. **Split Steps**: Create branching logic using split steps with multiple options\n4. **End Steps**: Mark steps as terminating to end the workflow\n\n### 3. Assign Actions to Steps\nEach step requires an action definition:\n1. Query available actions using `GET /workflowActionDefinitions`\n2. Assign action by setting `actionDefinitionId` in the step\n3. For split steps, create options using `POST /workflows/{workflowId}/steps/{stepId}/splitOptions`\n4. Each split option must have a matching action type\n\n### 4. Connect Steps in Sequence\nLink steps together to create the workflow flow:\n1. Set `nextStepId` to connect steps in sequence\n2. Use `POST /workflows/{workflowId}/steps/{stepId}/nextSteps/{detachedStepId}` to attach steps\n3. For split steps, each option can lead to different next steps\n\n### 5. Publish the Workflow\nMake the workflow available to users:\n1. Use `PATCH /workflows/{workflowId}` with `publishedDetails.status: 'PUBLISHED'`\n2. The workflow must be valid before publishing\n3. Published workflows can be assigned to captive portal networks"}},"baseSlug":"/api/workflow-api-0.0.4_1","routesMapping":{}}