logo logo
DOCS
  • INUBIT
  • REST API
  • Resources
  • Server
Deutsch (DE) English (EN)
8.1 8.0 7.4

INUBIT

    • Installation Guide
      • System Requirements
      • Installing INUBIT Software
      • Licensing
      • Configuring Databases
      • Starting/stopping the INUBIT Process Engine
      • Starting the INUBIT Workbench and Logging In
      • INUBIT Workbench: Activating a Warning on License Expiration
      • Starting and Stopping the Business Process Center
      • Importing the BusinessProcessCenter user group as additional user group
      • More Information
    • Patch Guide
      • Standard patch steps
        • Patching with the patch installer
        • Update of the Java distribution
        • Application server update (Apache Tomcat)
        • Update the Workbench
        • Using the latest script files
        • Patch Business Process Center (BPC)
          • Update of the INUBIT BPC modules
          • Update of the BPC workflows
      • Version-dependent patch steps
    • Migration Guide
      • Overview
      • Backing Up the Source System
      • Installing and Configuring the INUBIT Software
      • Executing the Migration Script
      • Migrating Remote Connectors
      • EDI Migration
      • Starting up and Testing the INUBIT Software
    • Administration Guide
      • The INUBIT Architecture
      • General Settings of the INUBIT Software
        • Configuring INUBIT via the Workbench
        • Configuring INUBIT in the ibis.xml File
        • Configuring Logging
        • Administering Users, Server, Proxy, Threads, Languages etc.
        • Configuring the Portal Server
        • Configuring Portal Deployment
        • Configuring the Process User Server
        • Configuring Memory Check in the ibis.properties File
      • Configuring Tomcat
      • Configuring Secure Connections
      • Managing Users
        • Changing the User-Specific Working Directory of the INUBIT Workbench
        • Administrating Process Engine Users
        • Keycloak User Management
        • Connecting and Configuring Process Users and Roles
        • Managing User Groups
        • Managing User Roles
        • Managing Process Roles
        • Editing the Queue Manager Filter
      • EDI Rule Management
      • Credentials Management
      • Technical Monitoring
      • Managing INUBIT Databases
        • Binary Stores
        • Folder Structure
        • Configuring the Data Sources by using JNDI
        • Switching INUBIT Monitoring Database
        • Database Manager
        • Midnight Task
        • AS4 Message Store
      • Alerting
      • Backup and Restore
      • Creating Application and Diagram Profiles
      • Using the su Mode
      • Remote Connector
      • Security Measures
      • Optimizing Performance
      • Implementing Thin Clients
      • Developing and Installing Plug-ins
      • Command Line Interface
        • Execution Modes of the Command Line Interface
        • Configuring Database Connectivity Loss Tolerance
        • Managing Users and User Groups Using the CLI
        • Managing Objects Using the CLI
        • Configuring Workflow Threads Using the CLI
        • Exporting and Importing Process Run Time Data Using the CLI
        • Exporting and Importing Model Data Using the CLI
        • Exporting and Importing Module Data Using the CLI
        • Restoring a Backup of the INUBIT Process Engine
        • Managing Libraries and Drivers Using the CLI
        • Diagnosis Commands
        • Controlling the Maintenance Mode Using the CLI
        • Triggering the Midnight Task Using the CLI
        • Validating the Migration Backup Using the CLI
        • Fetching the List of XSLT Version 1.0 Usage
      • Virtimo Cluster manager
    • Workbench User Guide
      • Using the INUBIT Workbench
        • INUBIT Workbench User Interface
        • Changing INUBIT Workbench Settings
        • Updating the INUBIT Workbench
        • Creating and Deleting Login Profiles
        • Switch to Additional User Group
        • Publishing Modules and Diagrams
        • Renaming Diagrams, Diagram Groups, and Modules
        • Deleting Diagrams and Modules
        • Using the Editor
        • XPath Assistant
        • Regular Expressions
        • Searching the INUBIT Workbench
        • Deployment of Diagrams, Modules, Metadata, and Repository Files
        • Displaying Diffs: Comparing Diagrams, Modules and XML Documents
        • Comparing Connection Details on Different Process Engines and Deploying them
        • Instant Messages
        • Changing Your Own Password
      • Designer: Working with Diagrams
      • Module Editor: Working with Modules
      • Process Maps
      • Modeling Business Process Diagrams
      • Organization Diagrams
      • System Diagrams
      • Business Object Diagrams
      • Technical Workflow Diagrams
      • Reporting and Business Process Monitoring
      • Workflow Variables and Mappings
      • Using BPM Rules
      • Validating and Testing Diagrams
      • Using Metadata
      • Versioning, Tagging, and Revision
      • Repository: Managing Files Centrally
      • Business Process Center Portal
      • Shortcuts in the INUBIT Workbench
    • Module Guide
      • Data Converter
        • Complex Lookup Table
        • FO Converter
        • Lookup Table
        • Task Generator
          • Functional Principle: Task Generator for Forms and Web Applications
          • Creating Forms with the Form Designer
          • Form Designer User Interface
          • Dialog Descriptions in the Task Generator
          • Validating User Input in Forms
          • Creating Context-sensitive Online Help for Forms
          • Exporting and Importing Form Texts for Translation
          • Using and Creating Widgets
          • Using multi-tenancy in the Task Generator
          • Integrating Employees into Workflows by Tasks
          • Displaying Task Delegations in the Audit Log
          • Exporting JavaScript Files from the Repository
          • Transferring an Own UUID
        • XSLT Converter
      • Format Adapter
        • CSV Adapter
        • CSV-XML/XML-CSV Adapter
        • EDI Adapter
        • Flat Adapter
        • JSON Adapter
        • MIME Adapter
        • XLS Adapter
        • XLSX Adapter
      • System Connector
        • Default Dialogs
        • AS/400 Connector
        • AS2 Connector
        • AS4 Connector
        • Backup Connector
        • Database Connector
          • Querying Metadata
          • Creating Static SQL Queries Using the Database Connector
          • Creating Dynamic XML-Queries
          • Database Connector XML Queries: Structure and Examples
          • Dialog Descriptions
        • Execution Connector
        • File Connector
        • FTP Connector
        • HTTP Connector
        • IGUASU Connector
        • INUBIT IS Connector
        • JMS Connector
        • JS Connector
        • LDAP Connector
        • Mail Connector
        • Microsoft 365 Connector
        • OpenOffice Connector
        • RabbitMQ Connector
        • REST Connector
          • Use OpenID Connect Authorization in REST Connector
        • RosettaNet HTTPS Connector
        • SAP Connector
        • SNMP Connector
        • TCP/IP Connector
        • UDP Connector
        • VFS Connector
        • Web Application Connector
        • Web Services Connector
          • Functional Principle
          • Module Variables
          • Setting and Reading HTTP Header Variables
          • Providing a Web Service
          • Calling a Web Service
          • Asynchronous Web Services
          • Securing Web Services Providers by a Security Token Service
          • Creating Key Pairs for WS Security
          • Creating Key Pairs for WS Trust
          • Calling an STS-Secured Web Service Provider
          • Creating Operations for a Web Service
          • Overwriting PartnerLinks
          • Listing Active Web Services
          • Logging SOAP Messages
          • Transferring Binary Data as Attachments with MTOM
          • Dialog Descriptions
            • Dialog Provided Web Service
            • Dialog Invoked Web Service
            • Web Service Editor and its Tabs
              • Provided Service Tab
              • Invoked Service Tab
              • XML Schemas Tab
              • WSDL Editor Tab
              • Extended Tab in the Web Service Editor
              • SOAP Messages Tab
            • Dialog Web Service Settings
            • Dialog WS-Security Configuration - Input
            • Dialog WS-Security Configuration - Medium/Output
            • Dialog WS-ReliableMessaging Configuration
            • Dialog Edit Namespaces
        • WebDAV Connector
        • WebSphere MQ Connector
        • X.400 SE Connector
      • Utilities
        • Barcode Generator
        • Certificate Reader
        • Compressor
        • Cryptographer
        • Data Stream Analyzer
        • Data Stream Modifier
        • EDI Signature
        • Encoder
        • INUBIT IS Configuration
        • JSON Validator
        • Line Reader
        • Message Logger
        • PDF Toolbox
        • Process Data Logger
        • QR Code Generator
        • Report Data Collector
        • S/MIME
        • Workflow Variable Bundler
        • XML Diff
        • XML Enveloper
        • XML Formatter
        • XML Signer
        • XML Validator
        • ZUGFeRD PDF/A
      • Workflow Controls
        • Assign
        • Compensate
        • Compensate Scope
        • Demultiplexer
        • Empty
        • Exit
        • Joiner
        • Multiplexer
        • Reply
        • Rethrow
        • Splitter
        • Throw
        • Validate
        • Wait
        • Workflow Connector
        • Workflow Starter
    • REST API
      • Authentication
        • Access with INUBIT credentials
        • Access with external frontend credentials
      • Resources
        • Data Models
          • Get user model data
          • Get user model data by name
          • Get user model data by element id
          • Get user Technical Workflow module data by name
          • Import a diagram into users space
          • Export a diagram from users space
          • Delete diagram by name
          • Delete diagram by id
          • Delete a specific diagram version
          • Delete module by name
          • Delete module by id
          • Delete a specific module version
        • EDI Rules
          • Deploy EDI rule file
        • Library
          • Deploy a library
          • Delete a library
        • Monitoring
          • Check INUBIT application health
          • Monitor INUBIT application
          • Retrieve monitoring log
          • Retrieve monitoring log using combined criteria
          • Retrieve server information
        • Process Documentation
          • Get diagram images
          • Get process list for a diagram group
          • Get process list for a diagram Type
          • Get process list for multiple diagram types
          • Search in Process Documentation
        • Reports
          • Get all reports of a user
          • Get all report folders of a user
          • Get all reports in a single folder
          • Get single report data of a user
          • Get all INUBIT reports of a user
          • Deploy reports of a user
        • Repository
          • Delete repository file
          • Get INUBIT repository files
        • Server
          • Get System info
          • Get readiness status
          • Change readiness status
          • Get license content
          • Deploy license file
          • Get server configuration
          • Deploy server configuration
          • Deploy key / certificate
        • System Connectors
          • INUBIT IS Connector
            • Execute remote workflow
            • Validate remote workflow and module
        • Tasks
          • User task list operations
          • Get details of a task
          • Get tasks by filter
          • Get all delegations of a task
          • Get next available task
          • Get all ad hoc processes of a user
          • Get user task data
          • Get task units for a user
          • Get all widgets of a Task
          • Get all tasklist ExtJS ready to render
          • Get task details of a user by filter body
          • Change task details of a user
          • Delete task of a user
          • Delete all tasks
          • Submit a task
          • Get tasks by basic filter
          • Get pre-filtered Tasks
          • Start an ad-hoc process of a user
          • Get specific task widgets
          • Get form help text information or perform server-side validation
        • Users and Roles
          • Get all users
          • Delete a user
        • Webapps
          • Get all available webapp details
          • Load a webapp form from INUBIT
          • Submit webapp form to inubit
          • Load data in grid widget
          • Remove queue manager entries from INUBIT related to webapp
    • Tutorial
      • First Steps
      • Modeling Business Processes Using the Workbench
      • Integrating Systems and Automating Processes
      • Developing a Web Application in INUBIT Workbench
    • Feature List
      • General
      • Process Engine
      • Workbench
      • Modules and System Connectors
    • Changelogs
    • Deprecations
    • Removals
INUBIT  / 8.1
  • Language
    • Deutsch
    • English
  • BPC
    • 4.2
    • 4.1
    • 4.0
  • IGUASU
    • 3.4.0
  • INUBIT
    • 8.1
    • 8.0
    • 7.4
  • VIMON
    • 1.0
  • Virtimo
    • latest

Server

This part of the REST API provides access to server information.

Resources

  • Get System info

  • Get readiness status

  • Change readiness status

  • Get license content

  • Deploy license file

  • Get server configuration

  • Deploy server configuration

  • Deploy key / certificate

logo
Virtimo AG
Legal Notice
Privacy Policy
Support
Feedback
Help

©2010 - 2024 Virtimo AG
 - Made with ❤️ in Berlin
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen