Skip to content

QueBIT Product Documentation

REST API

Initializing search

QueBIT Product Documentation

ControlWORQ
ControlWORQ
- Welcome
- Release Notes
- Introduction
  Introduction
- User Guide
  User Guide
  - Overview
  - Web Client
    
    Web Client
    
    Web Client Guide
    
    Working with Journal Entries
  - Excel Client
    
    Excel Client
    
    Excel User Interface
    
    Excel Client Guide
    
    Using VBA with ControlWORQ
- Administration Guide
  Administration Guide
  - Overview
  - Installation
  - Installation
    
    Installation
    
    System Requirements
    
    Installation Guide
  - Administration
    
    Administration
    
    Cube Configuration
DataWORQ
DataWORQ
- Installation
  Installation
  - Native
    
    Native
    
    Prerequisites
    
    Windows Installation
    
    Windows Authentication (SQL Server JDBC)
    
    Upgrading
    
    Uninstalling
  - Native Installer
    
    Native Installer
    
    Prerequisites
    
    Windows Installation
  - Containerized
    
    Containerized
    
    Containerization Overview
    
    Prerequisites
    
    Windows Installation
    
    FAQs
  - Common
    
    Common
    
    License Requirements
    
    Setting the Security Mode
    
    Managing Users
- Getting Started
  Getting Started
- Reference Guide
  Reference Guide
  - Canvas
    
    Canvas
    
    Adding and Connecting Nodes
    
    Configuring and Running Nodes
    
    Add to Canvas
  - Flow Menus
    
    Flow Menus
    
    File
    
    Email Alerting
    
    Flow Details
    
    Run Profiles
    
    Run Profiles
    
    Orchestration
    
    Parameters
    
    Parameters By Node
  - Content
    
    Content
    
    File Management
    
    Flow Management
  - Nodes
    
    Nodes
    
    Common Node Features
    
    Source
    
    Source
    
    Flat File
    
    Database
    
    Script
    
    User Input
    
    Planning Analytics
    
    Anaplan Transactional
    
    Anaplan Bulk
    
    Excel File
    
    Pigment
    
    Smartsheet
    
    OneStream
    
    Adaptive
    
    S3
    
    Column
    
    Column
    
    Derive
    
    Filter
    
    Filler
    
    Reorder
    
    One Hot Encoder
    
    Script
    
    Pivot
    
    Row
    
    Row
    
    Sort
    
    Select
    
    Partition
    
    Join
    
    Union
    
    Aggregate
    
    Balance
    
    Sequence
    
    Text
    
    Text
    
    Text Search
    
    Topic Model
    
    Cleanse
    
    Prediction
    
    Prediction
    
    Forecast
    
    Classification
    
    Regression
    
    Association
    
    Cluster
    
    Survival
    
    Forecast Strategy
    
    Forecast Single Strategy
    
    Optimization
    
    Optimization
    
    NL Optimization
    
    LP Optimization
    
    Output
    
    Output
    
    Database
    
    Command Line
    
    REST Command
    
    Script
    
    Flow
    
    Planning Analytics Process
    
    Anaplan Process
    
    Export
    
    Export
    
    Flat File
    
    Database
    
    Planning Analytics
    
    Anaplan Transactional
    
    Anaplan Bulk
    
    Excel File
    
    Pigment
    
    Smartsheet
    
    OneStream
    
    Adaptive
    
    S3
    
    Calculation & Analysis
    
    Calculation & Analysis
    
    Time Series
    
    Business Rule
    
    Frequency
    
    Forecast Accuracy
    
    White Noise
    
    Forecast Category
    
    Chart
    
    Flow Control
    
    Flow Control
    
    Stop Execution
  - Jobs
    
    Jobs
    
    Jobs Scheduler
    
    File Watcher
    
    Cube Watcher
    
    Activity
    
    Activity
    
    Active Jobs
    
    Inactive Jobs
  - Connections
    
    Connections
    
    Cloud Connector
    
    Data Connections
    
    SMTP Connection
  - Users
    
    Users
    
    Active Sessions
    
    Flow Conflicts
    
    User Management
    
    User Management
    
    Manage Interactive Users
    
    Manage API Users
  - Settings
    
    Settings
    
    Application Settings
    
    Licensing
  - Exercises
    
    Exercises
    
    Node Examples
    
    Node Examples
    
    Source
    
    Source
    
    Flat File
    
    Script
    
    User Input
    
    Column
    
    Column
    
    Filter
    
    Row
    
    Row
    
    Sort
    
    Text
    
    Text
    
    Cleanse
    
    Output
    
    Output
    
    Flow
    
    Export
    
    Export
    
    Flat File
    
    How-To Exercises
    
    How-To Exercises
    
    Intro to DataWORQ
    
    Intro to DataWORQ
    
    Copy a Flow
    
    Flow Conflicts
    
    Run Part of a Flow
    
    Node Notes
    
    Flow Errors
    
    Flat File Management
    
    Flat File Management
    
    Combine Columns from Files
    
    Aggregate Data from Files
  - About
    
    About
    
    Wiki
    
    References
    
    About
    
    System Info
  - Business Problems and Use Cases
    
    Business Problems and Use Cases
    
    Business Problems
    
    Business Problems
    
    Intro to DataWORQ
    
    Database Management
    
    New Features and Orchestration
    
    Advanced Scripting
    
    Technical Orchestration
    
    Cleaning Text with Regular Expressions
    
    Setup and Configuration
    
    Use Cases
    
    Use Cases
    
    Common Tasks
    
    Common Tasks
    
    Create a Flow from an Existing Flow
    
    Run Part of a Multi-Branch Flow
    
    Review User Activity
    
    Review a Flow Error
    
    Moving Data
    
    Moving Data
    
    Flat Files to a Database
    
    Between Tables
    
    Change a Table Name Across Many Nodes
    
    Replacing Flat Files with Database Tables
    
    Transforming Data
    
    Transforming Data
    
    Manipulate Date Strings
    
    Clean and Aggregate Multiple Text Files
    
    SQL Queries
- New Features
  New Features
  - In-App Help
  - Hotkeys
- REST API
  REST API
- Release Notes
  Release Notes
- Legacy Versions
  Legacy Versions
  - Euclid Studio (v4 and lower)
    
    Euclid Studio (v4 and lower)
    
    Getting Started
    
    Live Demo
    
    Basic Mechanics
    
    Basic Mechanics
    
    Node Canvas
    
    Adding and Connecting Nodes
    
    Configuring Nodes
    
    Creating and Saving Flows
    
    Opening Flows
    
    Server Configuration
    
    Server Configuration
    
    Create a Database Connection
    
    Cloud Connector
    
    SMTP Settings
    
    Preferences
    
    Node Guide
    
    Node Guide
    
    Source
    
    Source
    
    Database
    
    Flat File
    
    Script
    
    User Input
    
    Column
    
    Column
    
    Derive
    
    One Hot Encoder
    
    Time Series
    
    Filter
    
    Filler
    
    Reorder
    
    Business Rule
    
    Script
    
    Row
    
    Row
    
    Sort
    
    Aggregate
    
    Select
    
    Join
    
    Balance
    
    Union
    
    Partition
    
    Text
    
    Text
    
    Cleanse
    
    Topic Model
    
    Expression Search
    
    Prediction
    
    Prediction
    
    Association
    
    Regression
    
    Classification
    
    Cluster
    
    Forecast
    
    Survival
    
    Optimization
    
    Optimization
    
    NL Optimization
    
    LP Optimization
    
    Output
    
    Output
    
    Flow
    
    Script
    
    REST Command
    
    Command Line
    
    Database Command
    
    Chart
    
    Export
    
    Export
    
    Flat File
    
    Database
    
    Executing Flows
    
    Executing Flows
    
    Planning Analytics
    
    REST API
    
    Web Interface
    
    Orchestration
    
    Orchestration
    
    Parameters
    
    Run Profiles
    
    File Watcher
    
    Jobs Scheduler
    
    Deprecated Features
    
    Deprecated Features
    
    APIs (Deprecated)
    
    APIs (Deprecated)
    
    REST API
    
    URL API
    
    Command Line Interface (Deprecated)
    
    Command Line Interface (Deprecated)
    
    JAR File
  - Euclid Studio (v5)
    
    Euclid Studio (v5)
    
    Installation
    
    Installation
    
    Prerequisites
    
    Windows Installation
    
    Windows Authentication
    
    Upgrading
    
    Uninstalling
    
    License Requirements
    
    Getting Started
    
    Getting Started
    
    What is a flow?
    
    Setting Up a New Flow
    
    Running a Flow
    
    Reference Guide
    
    Reference Guide
    
    Canvas
    
    Canvas
    
    Adding and Connecting Nodes
    
    Configuring and Running Nodes
    
    Add to Canvas
    
    Flow Menus
    
    Flow Menus
    
    File
    
    Email Alerting
    
    Flow Details
    
    Run Profiles
    
    Run Profiles
    
    Orchestration
    
    Parameters
    
    Parameters by Node
    
    Nodes
    
    Nodes
    
    Common Node Features
    
    Source
    
    Source
    
    Flat File
    
    Database
    
    Script
    
    User Input
    
    Planning Analytics
    
    Anaplan Transactional
    
    Anaplan Bulk
    
    Excel File
    
    Pigment
    
    Column
    
    Column
    
    Derive
    
    Filter
    
    Filler
    
    Reorder
    
    One Hot Encoder
    
    Script
    
    Row
    
    Row
    
    Sort
    
    Select
    
    Partition
    
    Join
    
    Union
    
    Aggregate
    
    Balance
    
    Sequence
    
    Text
    
    Text
    
    Cleanse
    
    Text Expression Search
    
    Text Topic Model
    
    Prediction
    
    Prediction
    
    Forecast
    
    Classification
    
    Regression
    
    Association
    
    Cluster
    
    Survival
    
    Forecast Strategy
    
    Forecast Single Strategy
    
    Optimization
    
    Optimization
    
    NL Optimization
    
    LP Optimization
    
    Output
    
    Output
    
    Database
    
    Command Line
    
    Rest Command
    
    Script
    
    Flow
    
    Planning Analytics Process
    
    Anaplan Process
    
    Export
    
    Export
    
    Flat File
    
    Database
    
    Planning Analytics
    
    Anaplan Transactional
    
    Anaplan Bulk
    
    Excel File
    
    Pigment
    
    Calculation & Analysis
    
    Calculation & Analysis
    
    Time Series
    
    Business Rule
    
    Frequency
    
    Forecast Accuracy
    
    White Noise
    
    Forecast Category
    
    Chart
    
    Jobs
    
    Jobs
    
    Jobs Scheduler
    
    File Watcher
    
    Cube Watcher
    
    Activity
    
    Activity
    
    Active Jobs
    
    Inactive Jobs
    
    Connections
    
    Connections
    
    Cloud Connector
    
    Data Connections
    
    Data Connections
    
    Flow Connections
    
    User Saved Connections
    
    Users
    
    Users
    
    Active Sessions
    
    Flow Conflicts
    
    Settings
    
    Settings
    
    Preferences
    
    Licensing
    
    About
    
    About
    
    Wiki
    
    References
    
    About
    
    System Info
    
    New Features
    
    New Features
    
    In-App Help
    
    Hotkeys
    
    REST API
    
    REST API
    
    Using the REST API
    
    REST API Reference

Table of contents

Articles in this section

DataWORQ
REST API

REST API¶

Articles in this section¶

Using the REST API
REST API Reference
Cloud Connector API Reference

Copyright © QueBIT Consulting

Made with Material for MkDocs