Skip to content

Resources for Taipy Enterprise Edition REST API

Tutorials

User Manual

Visual Elements

Reference

Gallery

Taipy

Release Notes
Release Notes
- Legacy
- Migration
Contributing
Contributing
- Code of Conduct
- Contributors
Tutorials
Tutorials
- Fundamentals
  Fundamentals
  - Getting Started
  - Creating a Sales Dashboard
    
    Creating a Sales Dashboard
    
    1 - Visual Elements
    
    2 - Styling
    
    3 - Charts
    
    4 - Multipage
  - Scenario management overview
  - First Realistic application
    
    First Realistic application
    
    1 - Data visualization page
    
    2 - Algorithms used
    
    3 - Scenario configuration
    
    4 - Scenario page
    
    5 - Performance page
  - Creating applications
    Creating applications
    
    Creating an LLM ChatBot
    
    Creating an LLM ChatBot
    
    Creating an RAG ChatBot
    
    Creating an RAG ChatBot
  - User Roles and Permissions
- Visuals
  Visuals
- Scenario Management
  Scenario Management
- Integration
  Integration
- Large Data
  Large Data
User Manual
User Manual
- User interface
  User interface
  - Pages
    
    Pages
    
    Navigation
    
    Dynamic page content
    
    Dialogs
    
    Panes
    
    Advanced
  - Visual elements
  - Binding variables
  - Callbacks
  - Styling
    
    Styling
    
    The Stylekit
  - Notifications
  - Extension libraries
    
    Extension libraries
    
    Static Elements
    
    Dynamic Elements
    
    Dynamic Elements
    
    Scalar properties
- Scenario features
  Scenario features
  - Data integration
    
    Data integration
    
    Data node config
    
    Data node usage
    
    Visual elements
    
    Data node history and validity
  - Task orchestration
    
    Task orchestration
    
    Hello world!
    
    Scenario config
    
    Scenario creation
    
    Scenario submission
    
    Visual elements
  - What-if analysis
    
    What-if analysis
    
    Multiple scenarios
    
    Recurrent scenarios
    
    Scenario comparison
  - Scenario and data management
    
    Scenario and data management
    
    Data node
    
    Data node
    
    Task
    
    Task
    
    Scenario
    
    Scenario
    
    Scenario config
    
    Submission
    
    Submission
    
    Job
    
    Job
    
    Sequence
    
    Sequence
    
    Cycle
    
    Cycle
  - Track activities and Trigger actions
    
    Track activities and Trigger actions
    
    Event description
    
    Registration
    
    Examples
  - Exposing REST APIs
    
    Exposing REST APIs
- Advanced features
  Advanced features
  - Configuration
    
    Configuration
    
    Configuring the GUI application
    
    Configuring the Core service
    
    Configuring jobs execution
    
    Configuration checker
    
    Advanced configuration
  - Versioning system
    
    Versioning system
    
    Development mode
    
    Experiment mode
    
    Production mode
  - Authentication and roles
    
    Authentication and roles
    
    Authentication
    
    Authorization
  - Scheduler
    
    Scheduler
- Running & deploying
  Running & deploying
  - Running
    
    Running
    
    The run() function
    
    Using an external web server
    
    Protect private files
    
    Running in a Notebook
  - Deployment
    
    Deployment
    
    On a local machine
    
    On a local machine
    
    On Linux servers
    
    On Linux servers
    
    Ubuntu
    
    RHEL
    
    Using Docker
    
    Using Docker
    
    For development
    
    For production
    
    On Azure
    
    On Azure
    
    On Heroku
    
    On Heroku
    
    On Databricks
    
    On Databricks
- Ecosystem
  Ecosystem
  - Command-line interface
    
    Command-line interface
    
    Help
    
    Create
    
    Run
    
    Manage versions
    
    Version
  - Taipy Studio
    
    Taipy Studio
    
    Building configurations
    
    Building configurations
    
    Managing configuration files
    
    Configuring elements
    
    Graph views
    
    Text edition
    
    GUI Markdown support
  - Taipy Designer
    
    Taipy Designer
    
    Getting Started
    
    Getting Started
    
    Simple example
    
    Tutorials
    Tutorials
    
    Quick tutorial
    
    Training
    
    User Manual
    User Manual
    
    Basics
    
    Properties
    
    Widgets
    Widgets
    
    Introduction
    
    Common concepts
    
    Basic inputs
    
    Basic displays
    
    Plots
    
    Geo & Time
    
    Annotation & Video
    
    Layout
    
    Multi-page
    
    Other topics
    Other topics
    
    Notifications
    
    Test & deploy
    
    Graphical properties reference
    Graphical properties reference
    
    Basic inputs & controls
    Basic inputs & controls
    
    Numeric Input
    
    Text Input
    
    Checkbox
    
    Switch
    
    Horizontal slider
    
    Vertical slider
    
    Double slider
    
    Trigger button
    
    Load file button
    
    Select
    
    Multi-select
    
    List
    
    Editable table
    
    Basic displays
    Basic displays
    
    Value Display
    
    KPI value
    
    Advanced KPI value
    
    Status led
    
    Progress bar
    
    Full-circular gauge
    
    Semi-circular gauge
    
    Arch-circular gauge
    
    'any' widget
    
    Table
    
    Plots
    Plots
    
    Line chart
    
    Bar chart
    
    Pie chart
    
    Plotly Python generic
    
    Geo & Time
    Geo & Time
    
    Leaflet JSON maps
    
    Address auto-completion
    
    Simple calender
    
    Date-range calendar
    
    Year Calenddar
    
    Simple clock
    
    Annotation & Video
    Annotation & Video
    
    Info
    
    Label
    
    Form
    
    Import Image
    
    Connect Image
    
    Markdown
    
    Generic HTML
    
    Camera
Visual Elements
Visual Elements
- Standard controls
  Standard controls
  - text
  - button
  - input
  - number
  - slider
  - toggle
  - date
  - date_range
  - chart
  - table
  - selector
  - file_download
  - file_selector
  - image
  - metric
  - progress
  - indicator
  - menu
  - navbar
  - status
  - login
  - chat
  - tree
- Scenario and Data management controls
  Scenario and Data management controls
- Blocks
  Blocks
  - part
  - expandable
  - dialog
  - layout
  - pane
Reference
Reference
- Python API
  Python API
  - taipy
    
    taipy
  - taipy.auth
    
    taipy.auth
    
    AllOf
    
    AllOf
    
    AnyOf
    
    AnyOf
    
    Authenticator
    
    Authenticator
    
    Authorize
    
    Authorize
    
    Credentials
    
    Credentials
    
    InvalidCredentials
    
    InvalidCredentials
    
    IsAuthenticated
    
    IsAuthenticated
    
    NoneOf
    
    NoneOf
    
    RoleTraits
    
    RoleTraits
    
    RoleTraitsFilter
    
    RoleTraitsFilter
    
    UnknownProtocolError
    
    UnknownProtocolError
    
    UserGroupsNotFound
    
    UserGroupsNotFound
    
    .config
    
    .config
    
    AuthenticationConfig
    
    AuthenticationConfig
    
    .exceptions
    
    .exceptions
    
    AuthenticatorError
    
    AuthenticatorError
  - taipy.common
    
    taipy.common
    
    .config
    
    .config
    
    Config
    
    Config
    
    Frequency
    
    Frequency
    
    GlobalAppConfig
    
    GlobalAppConfig
    
    Scope
    
    Scope
    
    Section
    
    Section
    
    UniqueSection
    
    UniqueSection
    
    .checker
    
    .checker
    
    Issue
    
    Issue
    
    IssueCollector
    
    IssueCollector
    
    .exceptions
    
    .exceptions
    
    ConfigurationUpdateBlocked
    
    ConfigurationUpdateBlocked
    
    InconsistentEnvVariableError
    
    InconsistentEnvVariableError
    
    InvalidConfigurationId
    
    InvalidConfigurationId
    
    LoadingError
    
    LoadingError
    
    MissingEnvVariableError
    
    MissingEnvVariableError
  - taipy.core
    
    taipy.core
    
    Cycle
    
    Cycle
    
    DataNode
    
    DataNode
    
    Job
    
    Job
    
    MongoDefaultDocument
    
    MongoDefaultDocument
    
    Orchestrator
    
    Orchestrator
    
    Scenario
    
    Scenario
    
    Sequence
    
    Sequence
    
    Status
    
    Status
    
    Submission
    
    Submission
    
    SubmissionStatus
    
    SubmissionStatus
    
    Submittable
    
    Submittable
    
    Task
    
    Task
    
    .config
    
    .config
    
    CoreSection
    
    CoreSection
    
    DataNodeConfig
    
    DataNodeConfig
    
    JobConfig
    
    JobConfig
    
    ScenarioConfig
    
    ScenarioConfig
    
    TaskConfig
    
    TaskConfig
    
    .data
    
    .data
    
    CSVDataNode
    
    CSVDataNode
    
    ExcelDataNode
    
    ExcelDataNode
    
    GenericDataNode
    
    GenericDataNode
    
    InMemoryDataNode
    
    InMemoryDataNode
    
    JSONDataNode
    
    JSONDataNode
    
    JoinOperator
    
    JoinOperator
    
    MongoCollectionDataNode
    
    MongoCollectionDataNode
    
    Operator
    
    Operator
    
    ParquetDataNode
    
    ParquetDataNode
    
    PickleDataNode
    
    PickleDataNode
    
    S3ObjectDataNode
    
    S3ObjectDataNode
    
    SQLDataNode
    
    SQLDataNode
    
    SQLTableDataNode
    
    SQLTableDataNode
    
    .exceptions
    
    .exceptions
    
    AttributeKeyAlreadyExisted
    
    AttributeKeyAlreadyExisted
    
    ConfigCoreVersionMismatched
    
    ConfigCoreVersionMismatched
    
    ConflictedConfigurationError
    
    ConflictedConfigurationError
    
    CycleAlreadyExists
    
    CycleAlreadyExists
    
    DataNodeConfigIsNotGlobal
    
    DataNodeConfigIsNotGlobal
    
    DataNodeIsBeingEdited
    
    DataNodeIsBeingEdited
    
    DataNodeWritingError
    
    DataNodeWritingError
    
    DeletingPrimaryScenario
    
    DeletingPrimaryScenario
    
    DependencyNotInstalled
    
    DependencyNotInstalled
    
    DifferentScenarioConfigs
    
    DifferentScenarioConfigs
    
    DoesNotBelongToACycle
    
    DoesNotBelongToACycle
    
    ExposedTypeLengthMismatch
    
    ExposedTypeLengthMismatch
    
    FileCannotBeRead
    
    FileCannotBeRead
    
    FileEmpty
    
    FileEmpty
    
    InsufficientScenarioToCompare
    
    InsufficientScenarioToCompare
    
    InvalidCustomDocument
    
    InvalidCustomDocument
    
    InvalidDataNodeType
    
    InvalidDataNodeType
    
    InvalidEventAttributeName
    
    InvalidEventAttributeName
    
    InvalidEventOperation
    
    InvalidEventOperation
    
    InvalidExposedType
    
    InvalidExposedType
    
    InvalidScenario
    
    InvalidScenario
    
    InvalidSequence
    
    InvalidSequence
    
    InvalidSequenceId
    
    InvalidSequenceId
    
    InvalidSubscriber
    
    InvalidSubscriber
    
    JobNotDeletedException
    
    JobNotDeletedException
    
    MissingAppendQueryBuilder
    
    MissingAppendQueryBuilder
    
    MissingReadFunction
    
    MissingReadFunction
    
    MissingRequiredProperty
    
    MissingRequiredProperty
    
    MissingWriteFunction
    
    MissingWriteFunction
    
    ModeNotAvailable
    
    ModeNotAvailable
    
    ModelNotFound
    
    ModelNotFound
    
    MultipleDataNodeFromSameConfigWithSameOwner
    
    MultipleDataNodeFromSameConfigWithSameOwner
    
    MultipleSequenceFromSameConfigWithSameOwner
    
    MultipleSequenceFromSameConfigWithSameOwner
    
    MultipleTaskFromSameConfigWithSameOwner
    
    MultipleTaskFromSameConfigWithSameOwner
    
    NoData
    
    NoData
    
    NonExistingComparator
    
    NonExistingComparator
    
    NonExistingCycle
    
    NonExistingCycle
    
    NonExistingDataNode
    
    NonExistingDataNode
    
    NonExistingDataNodeConfig
    
    NonExistingDataNodeConfig
    
    NonExistingExcelSheet
    
    NonExistingExcelSheet
    
    NonExistingJob
    
    NonExistingJob
    
    NonExistingScenario
    
    NonExistingScenario
    
    NonExistingScenarioConfig
    
    NonExistingScenarioConfig
    
    NonExistingSequence
    
    NonExistingSequence
    
    NonExistingSequenceConfig
    
    NonExistingSequenceConfig
    
    NonExistingTask
    
    NonExistingTask
    
    NonExistingTaskConfig
    
    NonExistingTaskConfig
    
    NonExistingVersion
    
    NonExistingVersion
    
    OrchestratorNotBuilt
    
    OrchestratorNotBuilt
    
    OrchestratorServiceIsAlreadyRunning
    
    OrchestratorServiceIsAlreadyRunning
    
    SQLQueryCannotBeExecuted
    
    SQLQueryCannotBeExecuted
    
    SequenceAlreadyExists
    
    SequenceAlreadyExists
    
    SequenceBelongsToNonExistingScenario
    
    SequenceBelongsToNonExistingScenario
    
    SequenceTaskConfigDoesNotExistInSameScenarioConfig
    
    SequenceTaskConfigDoesNotExistInSameScenarioConfig
    
    SequenceTaskDoesNotExistInScenario
    
    SequenceTaskDoesNotExistInScenario
    
    SheetNameLengthMismatch
    
    SheetNameLengthMismatch
    
    SubmissionNotDeletedException
    
    SubmissionNotDeletedException
    
    UnauthorizedTagError
    
    UnauthorizedTagError
    
    UnknownCompressionAlgorithm
    
    UnknownCompressionAlgorithm
    
    UnknownDatabaseEngine
    
    UnknownDatabaseEngine
    
    UnknownParquetEngine
    
    UnknownParquetEngine
    
    VersionAlreadyExistsAsDevelopment
    
    VersionAlreadyExistsAsDevelopment
    
    .notification
    
    .notification
    
    CoreEventConsumerBase
    
    CoreEventConsumerBase
    
    Event
    
    Event
    
    EventEntityType
    
    EventEntityType
    
    EventOperation
    
    EventOperation
    
    Notifier
    
    Notifier
    
    .reason
    
    .reason
    
    DataNodeEditInProgress
    
    DataNodeEditInProgress
    
    DataNodeIsNotWritten
    
    DataNodeIsNotWritten
    
    EntityDoesNotExist
    
    EntityDoesNotExist
    
    EntityIsNotAScenario
    
    EntityIsNotAScenario
    
    EntityIsNotSubmittableEntity
    
    EntityIsNotSubmittableEntity
    
    InvalidUploadFile
    
    InvalidUploadFile
    
    JobIsNotFinished
    
    JobIsNotFinished
    
    NoFileToDownload
    
    NoFileToDownload
    
    NotAFile
    
    NotAFile
    
    NotGlobalScope
    
    NotGlobalScope
    
    Reason
    
    Reason
    
    ReasonCollection
    
    ReasonCollection
    
    ScenarioDoesNotBelongToACycle
    
    ScenarioDoesNotBelongToACycle
    
    ScenarioIsThePrimaryScenario
    
    ScenarioIsThePrimaryScenario
    
    SubmissionIsNotFinished
    
    SubmissionIsNotFinished
    
    SubmissionStatusIsUndefined
    
    SubmissionStatusIsUndefined
    
    UploadFileCanNotBeRead
    
    UploadFileCanNotBeRead
    
    WrongConfigType
    
    WrongConfigType
  - taipy.enterprise
    
    taipy.enterprise
    
    ScheduledMethod
    
    ScheduledMethod
    
    Scheduler
    
    Scheduler
    
    .core
    
    .core
    
    .config
    
    .config
    
    MigrationConfig
    
    MigrationConfig
    
    TelemetrySection
    
    TelemetrySection
    
    .exceptions
    
    .exceptions
    
    DataToBeImportAlredyExist
    
    DataToBeImportAlredyExist
    
    EntitiesToBeImportAlredyExist
    
    EntitiesToBeImportAlredyExist
    
    ExportPathAlreadyExists
    
    ExportPathAlreadyExists
    
    ImportArchiveDoesntContainAnyScenario
    
    ImportArchiveDoesntContainAnyScenario
    
    ImportScenarioDoesntHaveAVersion
    
    ImportScenarioDoesntHaveAVersion
    
    PermissionDenied
    
    PermissionDenied
    
    VersionAlreadyExistsAsProduction
    
    VersionAlreadyExistsAsProduction
    
    VersionIsNotProductionVersion
    
    VersionIsNotProductionVersion
    
    .gui
    
    .gui
    
    AuthorizedPage
    
    AuthorizedPage
    
    .gui_actions
    
    .gui_actions
    
    .rest
    
    .rest
    
    .api
    
    .api
    
    .resources
    
    .resources
    
    LoginEndpoint
    
    LoginEndpoint
    
    LogoutEndpoint
    
    LogoutEndpoint
    
    .schemas
    
    .schemas
    
    LoginSchema
    
    LoginSchema
  - taipy.gui
    
    taipy.gui
    
    Gui
    
    Gui
    
    Html
    
    Html
    
    Icon
    
    Icon
    
    Markdown
    
    Markdown
    
    Page
    
    Page
    
    Partial
    
    Partial
    
    State
    
    State
    
    .builder
    
    .builder
    
    Page
    
    Page
    
    button
    
    button
    
    chart
    
    chart
    
    chat
    
    chat
    
    content
    
    content
    
    data_node
    
    data_node
    
    data_node_selector
    
    data_node_selector
    
    date
    
    date
    
    date_range
    
    date_range
    
    dialog
    
    dialog
    
    expandable
    
    expandable
    
    file_download
    
    file_download
    
    file_selector
    
    file_selector
    
    html
    
    html
    
    image
    
    image
    
    indicator
    
    indicator
    
    input
    
    input
    
    job_selector
    
    job_selector
    
    layout
    
    layout
    
    login
    
    login
    
    menu
    
    menu
    
    metric
    
    metric
    
    navbar
    
    navbar
    
    number
    
    number
    
    pane
    
    pane
    
    part
    
    part
    
    progress
    
    progress
    
    scenario
    
    scenario
    
    scenario_dag
    
    scenario_dag
    
    scenario_selector
    
    scenario_selector
    
    selector
    
    selector
    
    slider
    
    slider
    
    status
    
    status
    
    table
    
    table
    
    text
    
    text
    
    toggle
    
    toggle
    
    tree
    
    tree
    
    .data
    
    .data
    
    Decimator
    
    Decimator
    
    LTTB
    
    LTTB
    
    MinMaxDecimator
    
    MinMaxDecimator
    
    RDP
    
    RDP
    
    ScatterDecimator
    
    ScatterDecimator
    
    .extension
    
    .extension
    
    Element
    
    Element
    
    ElementLibrary
    
    ElementLibrary
    
    ElementProperty
    
    ElementProperty
    
    .types
    
    .types
    
    PropertyType
    
    PropertyType
  - taipy.gui_core
    
    taipy.gui_core
  - taipy.rest
    
    taipy.rest
    
    Rest
    
    Rest
    
    .api
    
    .api
    
    .error_handler
    
    .error_handler
    
    .exceptions
    
    .exceptions
    
    ConfigIdMissingException
    
    ConfigIdMissingException
    
    ScenarioIdMissingException
    
    ScenarioIdMissingException
    
    SequenceNameMissingException
    
    SequenceNameMissingException
    
    .resources
    
    .resources
    
    CycleList
    
    CycleList
    
    CycleResource
    
    CycleResource
    
    DataNodeList
    
    DataNodeList
    
    DataNodeReader
    
    DataNodeReader
    
    DataNodeResource
    
    DataNodeResource
    
    DataNodeWriter
    
    DataNodeWriter
    
    JobExecutor
    
    JobExecutor
    
    JobList
    
    JobList
    
    JobResource
    
    JobResource
    
    ScenarioExecutor
    
    ScenarioExecutor
    
    ScenarioList
    
    ScenarioList
    
    ScenarioResource
    
    ScenarioResource
    
    SequenceExecutor
    
    SequenceExecutor
    
    SequenceList
    
    SequenceList
    
    SequenceResource
    
    SequenceResource
    
    TaskExecutor
    
    TaskExecutor
    
    TaskList
    
    TaskList
    
    TaskResource
    
    TaskResource
    
    .schemas
    
    .schemas
    
    CSVDataNodeConfigSchema
    
    CSVDataNodeConfigSchema
    
    CycleResponseSchema
    
    CycleResponseSchema
    
    CycleSchema
    
    CycleSchema
    
    DataNodeConfigSchema
    
    DataNodeConfigSchema
    
    DataNodeFilterSchema
    
    DataNodeFilterSchema
    
    DataNodeSchema
    
    DataNodeSchema
    
    ExcelDataNodeConfigSchema
    
    ExcelDataNodeConfigSchema
    
    GenericDataNodeConfigSchema
    
    GenericDataNodeConfigSchema
    
    InMemoryDataNodeConfigSchema
    
    InMemoryDataNodeConfigSchema
    
    JSONDataNodeConfigSchema
    
    JSONDataNodeConfigSchema
    
    JobSchema
    
    JobSchema
    
    MongoCollectionDataNodeConfigSchema
    
    MongoCollectionDataNodeConfigSchema
    
    PickleDataNodeConfigSchema
    
    PickleDataNodeConfigSchema
    
    SQLDataNodeConfigSchema
    
    SQLDataNodeConfigSchema
    
    SQLTableDataNodeConfigSchema
    
    SQLTableDataNodeConfigSchema
    
    ScenarioResponseSchema
    
    ScenarioResponseSchema
    
    ScenarioSchema
    
    ScenarioSchema
    
    SequenceResponseSchema
    
    SequenceResponseSchema
    
    SequenceSchema
    
    SequenceSchema
    
    TaskSchema
    
    TaskSchema
    
    .datanode
    
    .datanode
    
    OperatorSchema
    
    OperatorSchema
    
    .job
    
    .job
    
    CallableSchema
    
    CallableSchema
    
    .views
    
    .views
    
    .app
    
    .app
    
    .apispec
    
    .apispec
    
    APISpecExt
    
    APISpecExt
    
    FlaskRestfulPlugin
    
    FlaskRestfulPlugin
    
    .extensions
    
    .extensions
- REST API
  REST API
- GUI Extension API
  GUI Extension API
  - taipy-gui module
Gallery
Gallery
- Finance
  Finance
- Decision Support
  Decision Support
- LLM
  LLM
- Visualization
  Visualization
- Other
  Other

Resources for Taipy Enterprise Edition REST API

Classes¶

LoginEndpoint: Login endpoint
LogoutEndpoint: Logout endpoint