Before exploring the individual endpoints, Adabas RESTful APIs can be accessed and tested using Swagger UI. Swagger UI provides a browser-based interface that displays the available REST endpoints, parameters, and response formats defined in the OpenAPI (Swagger) specification.
Swagger UI also provides interactive features that enhance usability:
Users can view example request payloads and sample responses, helping them understand the expected input and output format.
The “Try it out” feature allows users to modify parameters and execute API calls in real time, with responses displayed immediately.
Responses include HTTP status codes and error messages, which can be useful for testing and troubleshooting.
Using Swagger UI, users can explore the available API functions and execute REST requests directly from the browser without using command-line tools.
Swagger UI can be accessed using the following URL:
http(s)://<server-host>:<port>/docs
By default, the Adabas RESTful server uses port 8190 for HTTP and 8191 for HTTPS. These ports can be configured in:
<SAG installation>/AdabasRestAdministration/configuration/config.xml
To enable HTTPS access, a keystore file or PEM-based certificate and private key must be configured for the RESTful server. For details, refer to the section RESTful Security.
The scheme (HTTP or HTTPS) is determined by the URL used to access Swagger UI.
All endpoints described in the sections below are available through Swagger UI as well as through any REST client, such as curl or scripts.
The following lists of endpoints are available in Adabas RESTful administration. Parameters marked with an asterisk (*) are mandatory.
| Endpoint | Method | Description |
|---|---|---|
| /adabas/config/ | GET | Get Adabas configuration
Parameters: No parameters |
| PUT | Store configuration
Parameters: data*: Configuration content |
|
| POST | Store configuration
Parameters: No parameters |
|
| /adabas/config/classic | GET | Define the Adabas direct access
Parameters: No parameters |
| POST | Add an entry for the Adabas direct access
Parameters: url: Database URL global: Global classic database access parameter |
|
| DELETE | Delete an entry in the configuration
Parameters: url*: Database URL |
|
| /adabas/config/cluster | GET | Get the cluster node entries
Parameters: |
| /adabas/config/jobs | GET | Read Adabas job configuration section
Parameters: No parameters |
| PUT | Set the ADADATADIR
Parameters: jobConfig: Job configuration |
|
| /adabas/config/mapping | GET | Define the current Adabas Map repositories
Parameters: No parameters |
| POST | Add configuration in Adabas Map repositories
url*: Database URL file*: Database file number |
|
| DELETE | Delete entry in configuration
url*: Database URL file*: Database file number |
|
| /adabas/config/module | GET | Define the current Adabas module section
Parameters: No parameters |
| PUT | Set the ADADATADIR
Parameters: adadatadir*: Adabas Database DATADIR location |
|
| /adabas/config/module/directories | GET | Read upload/download directories
Parameters: No parameters |
| POST | Add directory location
Parameters: location*: Directory path to add name*: Name of upload/download location |
|
| DELETE | Delete the directory location
Parameters: name*: Name of the directory location to delete |
|
| /adabas/config/module/installation | GET | Retrieve the current Adabas installation
configuration
Parameters: No parameters |
| POST | Add a new Adabas installation location
Parameters: installation*: Installation directory path to add |
|
| DELETE | Remove an existing Adabas installation
location
Parameters: installation*: Installation directory path to remove |
|
| /adabas/config/server | GET | Retrieve the current Adabas server configuration
Parameters: No parameters |
| /adabas/license | POST | Upload license
Parameters: sag*: Upload SAG environment destination name*: Upload name of license file uploadLicense*: Upload license content of field |
| /adabas/rest/env | GET | Retrieve the list of environments
Parameters: No parameters |
| /adabas/rest/log | GET | Retrieve Rest server log
Parameters: No parameters |
| /adabas/version | GET | Retrieve the current Adabas version
Parameters: No parameters |
| /env | GET | Retrieve the list of environments
Parameters: No parameters |
| /login | GET | Login receiving JSON Web Token (JWT)
Parameters: No parameters |
| POST | Login receiving JSON Web Token (JWT)
Parameters: No parameters |
|
| PUT | Login receiving JSON Web Token (JWT)
Parameters: No parameters |
|
| /logout | GET | Remove the current session
Parameters: No parameters |
| /rest/logoff | GET | Remove the current session
Parameters: No parameters |
| /shutdown/{hash} | PUT | Initiate server shutdown
Parameters: hash*: Shutdown validation hash |
| /version | GET | Retrieve the current version
Parameters: No parameters |
| Endpoint | Method | Description |
|---|---|---|
| /adabas/cluster | GET | Retrieve the current Adabas cluster status
Parameters: No parameters |
| /adabas/database/{dbid}/actstats | GET | Retrieve Adabas activity statistics
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/bfstats | GET | Retrieve Adabas buffer flush statistics
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/bpstats | GET | Retrieve Adabas buffer pool statistics
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/checkpoints | GET | Retrieve the list of Adabas checkpoints for the specified database
Parameters: dbid*: Database ID start_time: Timestamp of first checkpoint entry end_time: Timestamp of last checkpoint entry |
| DELETE | Delete Adabas checkpoints for the specified database
Parameters: dbid*: Database ID start_time: Timestamp of first checkpoint entry end_time: Timestamp of last checkpoint entry |
|
| /adabas/database/{dbid}/cluster | GET | Retrieve the current Adabas cluster status for the specified database
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| PUT | Trigger a primary node switch
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> primary_node*: Cluster primary node name |
|
| /adabas/database/{dbid}/commandqueue | GET | Retrieve a list of user queue entries for the specified database
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> rfc3339: Return timestamps in RFC3339 format (true /false) |
| /adabas/database/{dbid}/commandstats | GET | Retrieve Adabas command statistics for the specified database
Parameters: dbid*: Database ID |
| DELETE | Reset Adabas command statistics for specified database
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
|
| /adabas/database/{dbid}/file | POST | Create a new Adabas file in the specified database
Parameters dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> fdufdt: Please refer to the example value in the Swagger API |
| /adabas/database/{dbid}/file/{file_operation} | POST | Create a new Adabas file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file_operation*: File number (the file number in the body is ignored) name: Used for the rename operation number: Used for the renumber operation fdufdt: Please refer to the example value in the Swagger API |
| PUT | Adapt a Adabas file parameter
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file_operation*: File number and operation, separated by a ‘:’. Supported operations: renumber, refresh number: New file number (for renumber operation) name: New file name (for rename operation) pgmrefresh: Set PGM refresh (true/false) spacereusage: Enable/disable space reuse (true/false) isnreusage: Enable/disable ISN reuse (true/false) spannedrecords: Enable/disable spanned records, need to be given exclusive (true/false) |
|
| /adabas/database/{dbid}/holdqueue | GET | Retrieve a list of hold queue entries
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> rfc3339: Return timestamps in RFC3339 format (true/false) |
| /adabas/database/{dbid}/hwm | GET | Retrieve Adabas High water mark
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> rfc3339: Return timestamps in RFC3339 format (true/false) |
| DELETE | Reset Adabas high water statistics
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
|
| /adabas/database/{dbid}/monitor | GET | Retrieve Adabas monitor statistics
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/permission | GET | List RBAC assignments permission
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> list: List for all types. (Available values: assignments, userrole) user: List by User role: List by Role |
| POST | Grant RBAC permission
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> definition: Please follow the example value in the Swagger API |
|
| DELETE | Revoke RBAC permission
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> definition: Please follow the example value in the Swagger API |
|
| /adabas/database/{dbid}/permission/{resource} | GET | List RBAC resources
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> resource*: RBAC type (Available values: Role, role, ROLE, Object, object, OBJECT, User, user, USER, Operation, operation, OPERATION) |
| /adabas/database/{dbid}/permission/{resource}/{name} | POST | Create RBAC resource
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> resource*: RBAC type (Available values: Role, role, ROLE, Object, object, OBJECT, User, user, USER, Operation, operation, OPERATION) name*: resource name |
| DELETE | Drop RBAC resource
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> resource*: RBAC type (Available values: Role, role, ROLE, Object, object, OBJECT, User, user, USER, Operation, operation, OPERATION) name*: resource name |
|
| /adabas/database/{dbid}/plog | GET | Retrieve the current PLOG statistics of Adabas PLOG
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/tcp | GET | Retrieve the current status of ADATCP/IP communication
Parameters: dbid*: Database ID |
| POST | Enable or disable TCP for the given dbid
Parameters: dbid*: Database ID enabled: Enable or disable TCP for the given dbid (true/false) |
|
| /adabas/database/{dbid}/tcpinfo | GET | Retrieve the current ADATCP connection of Adabas
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| DELETE | Disconnect ADATCP connection in the database with the given dbid
Parameters: dbid*: Database ID start_id: First entry of ADATCP connection ID end_id: Last entry of ADATCP connection ID |
|
| /adabas/database/{dbid}/threadtable | GET | Retrieve Adabas Thread Table
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/userqueue | GET | Retrieve a list of user queue entries
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> rfc3339: Return timestamps in RFC3339 format (true/false) |
| /adabas/database/{dbid}/userqueue/{queueid} | GET | Provide User queue details of a specific user queue element
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> queueid*: User Queue ID rfc3339: Return timestamps in RFC3339 format (true/false) |
| DELETE | Stop the User Queue element
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> queueid*: User Queue ID toqueueid: If range of users this is the user id end User Queue entry |
| Endpoint | Method | Description |
|---|---|---|
| /adabas/database | POST | Create a new Adabas database, the input needs to be JSON. A structure level
parameter indicates Adabas version to be used.
Parameters: database: Please refer to the example value in Swagger API |
| /adabas/database/{dbid_operation} | DELETE | Delete the Adabas database
Parameters: dbid_operation*: Database ID |
| /adabas/database/{dbid}/container/{container_type} | DELETE | Delete a Adabas container
Parameters: dbid*: Database ID container_type*: Container type, may be ASSO or DATA |
| Endpoint | Method | Description |
|---|---|---|
| /adabas/database | GET | Retrieve a list of databases known by Adabas Interface.
Parameters: No parameters |
| /adabas/database/{dbid_operation} | GET | Retrieve the current status of database with the given dbid
Parameters: dbid_operation*: Database ID optional with operation append with : like 123:shutdown. Possible operations are: cancel, shutdown, abort, start |
| POST | Initiate operations on the given dbid
Parameters: dbid_operation*: Database ID optional with operation append with : like 123:shutdown. Possible operations are: cancel, shutdown, abort, start, feofclog, feofplog, feofelog etsync: Only used together with PLOG FEOF (true/false) |
|
| PUT | Change resource of the given database
Parameters: dbid_operation*: Database ID (123) or Database ID optional with operation append with : like 123:shutdown. Possible operations are: cancel, shutdown, abort, start, feofclog, feofplog, feofelog name: Database name eventing: Enable or disable eventing(true/false) writelimit: Set Write Limit lock: Lock database (true/false) externalbackup: External database backup (true=prepare false=continue) |
|
| /adabas/database/{dbid}/GCB | GET | Retrieve the current GCB of the database with the given dbid
Parameters: dbid*: Database ID rfc3339: Return timestamps in RFC3339 format (true/false) |
| /adabas/database/{dbid}/container | GET | Retrieve Adabas containers
Parameters: dbid*: Database ID |
| POST | Add a container to Adabas
Parameters: dbid*: Database ID database: Please refer to the example value in Swagger API |
|
| /adabas/database/{dbid}/container/{container_type} | POST | Add a container type to Adabas
Parameters: dbid*: Database ID container_type*: Container type, may be ASSO or DATA database: Please refer to the example value in Swagger API |
| /adabas/database/{dbid}/fields/{file} | GET | Retrieve Adabas FDT information for a file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number and operation separated by ':'. Possible operations are: refresh, renumber rfc3339: Return timestamps in RFC3339 format (true/false) filepassword: Password to access a password-protected file |
| POST | Modify Adabas FDT information for a file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number addfields*: Add fields to the FDT |
|
| PUT | Change a list of fields in an Adabas file, first drop or add fields
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number drop: List of fields to be deleted add: Add fields to the FDT change: Change fields to the FDT |
|
| DELETE | Drop a list of fields in an Adabas file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number fields*: List of fields to be deleted |
|
| /adabas/database/{dbid}/file | GET | Retrieve a list of files defined in the database
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> |
| /adabas/database/{dbid}/file/{file_operation} | GET | Retrieve Adabas FCB information for a file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file_operation*: File number and operation, separated by ‘:’. Possible operations are: refresh, renumber, rename, addlob name: Used for operation rename number: Used for operation renumber/ addlob uiblocksize: Used for operation addlob (in kilobyte unit). Input format (separated by ‘:’ if there are 2 entries): number or number:number. Note: if you specify two block sizes, one value should be < 16K, and one value should be >= 16K. You should also specify two values for UISIZE; the first value for UIBLOCKSIZE corresponds to the first value of UISIZE, and the second value for UIBLOCKSIZE corresponds to the second value of UISIZE niblocksize: Used for operation addlob (in kilobyte unit). Input format (separated by ‘:’ if there are 2 entries): number or number:number. Note: if you specify two block sizes, one value should be < 16K, and one value should be >= 16K. You should also specify two values for NISIZE; the first value for NIBLOCKSIZE corresponds to the first value of NISIZE, and the second value for NIBLOCKSIZE corresponds to the second value of NISIZE nisize: Used for operation addlob (in blocks or megabytes unit). Input format (separated by ‘:’ if there are 2 entries): number[B:M] or number[B:M]: number[B:M]:. Note: If you specify two NIBLOCKSIZE, you should also specify two values for NISIZE uisize: Used for operation addlob (in blocks or megabytes unit). Input format (separated by ‘:’ if there are 2 entries): number[B:M] or number[B:M]: number[B:M]:. Note: If you specify two UIBLOCKSIZE, you should also specify two values for UISIZE acblocksize: Used for operation addlob (in kilobyte unit) rfc3339: Return timestamps in RFC3339 format (true/false) |
| DELETE | Delete the file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file_operation*: File number, no operation possible |
|
| /adabas/database/{dbid}/gcb | GET | Retrieve the current GCB of the database with the given dbid
Parameters: dbid*: Database ID rfc3339: Return timestamps in RFC3339 format (true/false) |
| /adabas/database/{dbid}/nuclog | GET | Retrieve Adabas nucleus log
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> list: List all available (true/false) name: Get specific adanuc log, default is adanuc.log |
| /adabas/database/{dbid}/parameter | GET | Retrieve Adabas parameters
Parameters: dbid*: Database ID type*: Type of parameter static or dynamic. (Available type: dynamic, DYNAMIC, static, STATIC) |
| POST | Change Adabas parameter, Adabas parameter can even be given as request
parameter
Parameters: dbid*: Database ID type*: Type of parameter static or dynamic. (Available type: dynamic, DYNAMIC, static, STATIC) parameter: Please refer to the example value in the Swagger API |
|
| PUT | Change Adabas parameter, Adabas parameter can even be given as request
parameter
Parameters: dbid*: Database ID type*: Type of parameter static or dynamic. (Available type: dynamic, DYNAMIC, static, STATIC) AR: Action if a restart detects that the last system crash was during a buffer flush BI: Write before image to PLOG (true/false) CLOGLAYOUT: Select layout of CLOG PLOG: Protection logging (true/false) LPXA: Size of XA area BFIO: Limit of parallel buffer flush IOs CLOGBMAX: Length of Adabas buffers logged LOGGING: Command logging NCL: Number of local client threads NISNHQ: Maximum number of ISNs in hold per user NT: Number of threads NU: Number of user queue elements OPTIONS: Various options TNAA: Non-activity time limit (ACC only users) TNAE: Non-activity time limit (ET Logic users) TNAX: Non-activity time limit (EXU, EXF users) TT: Transaction time limit USEREXITS: User exit(s) to be used RPL_RECORDS: Read parallel limits records RPL_BLOCKS: Read parallel limits blocks RPL_TOTAL: Read parallel limits total LAB: Length of attached buffers area LABX: Length of attached buffers extended area LBP: Adabas buffer pool size LWP: Length of Adabas Work Pool WRITE_LIMIT: Buffer pool modification limit APU_UNITS: Number of APUs APU_WORKERS: Number of worker threads per APU APU_RECVS: Number of receiver threads per APU ADATCP: ADATCP (true/false) ADATCPPORT: TCP/IP receiver port number ADATCPATB: Attached buffer size for ADATCP receivers ADATCPRECEIVER: Number of ADATCP receiver threads ADATCPCONNECTIONS: Maximum number of parallel ADATCP connections per receiver thread SSLPORT: The TCP/IP port for encrypted communication SSLPORTNUMBER: The TCP/IP port for encrypted communication SSLCERTFILE: Certificate file for encrypted communication SSLKEYFILE: Private key file for encrypted communication SSLVERIFY: Verification level of client certificates SSLCAFILE: CA certificate file or certificate chain file SSLCADIRECTORY: Directory name where certificates of the Certificate Authority are stored SSLPASSWORD: Passphrase of file name which contains the passphrase CLUSTER_BOOTSTRAP: Cluster bootstrap (true/false) CLUSTER_PORT: TCP/IP port for cluster communication CLUSTER_URL: Cluster nodes address CLUSTER_DONOR_NAMES: Node name which should transfer data (IST or SST) to a joining node CLUSTER_IST_PORT: TCP/IP port for Incremental State Transfer CLUSTER_LOG_LEVEL: Maximum log level of cluster messages: FATAL|ERROR|WARN|INFO|DEBUG CLUSTER_PUBLIC_HOST: Cluster public host CLUSTER_PUBLIC_PORT: Cluster public port CLUSTER_OPTIONS: Allow additional provider library parameter settings CLUSTER_SST_PORT: TCP/IP for State Snapshot Transfer CLUSTER_NODE_NAME: Cluster node name type*: Type of parameter static or dynamic. (Available values: dynamic, DYNAMIC, static, STATIC) |
|
| /adabas/database/{dbid}/parameterinfo | GET | Retrieve Adabas parameter metadata information
Parameters: dbid*: Database ID |
| /adabas/database/{dbid}/ucb | GET | Retrieve Adabas UCB entries
Parameters: dbid*: Database ID rfc3339: Return time format in RFC3339(true/false) |
| /adabas/database/{dbid}/ucb/{ucbid} | DELETE | Delete an Adabas UCB entry
Parameters: dbid*: Database ID ucbid*: UCB entry id |
| /adabas/env | GET | Retrieve a list of Adabas version installations used
Parameters: No parameters |
| /adabas/{clusterid}/getclusterinfo | GET | Verify Cluster Connection String which mapped in dbmapping.txt or using
connection string parameter.
Parameters: clusterid*: Cluster ID or ADATCP short reference like adatcp:<host>:<port> |
| Endpoint | Method | Description |
|---|---|---|
| /scheduler/execution | GET | Retrieve a specific job result
Parameters: from: Start time from to: End time to start_time: Timestamp of first job execution entry end_time: Timestamp of last job execution entry |
| /scheduler/job | GET | Retrieve a list of jobs known by Adabas Interface
Parameters: start_time: Timestamp of first job entry end_time: Timestamp of last job entry |
| POST | Create a new Job database
Parameters: job: Please refer to the example value in the Swagger API |
|
| /scheduler/job/{jobName} | GET | Retrieve a job definition
Parameters: j obName*: Job Name to be requested |
| PUT | Schedule an already defined Job
Parameters: jobName*: Job Name to be requested |
|
| POST | Update an already defined Job
Parameters: jobName*: Job Name to be requested |
|
| DELETE | Delete a job definition
Parameters: jobName*: Job Name to be requested |
|
| /scheduler/job/{jobName}/full | GET | Retrieve a full job definition
Parameters: jobName*: Job Name to be requested |
| /scheduler/job/{jobName}/result | GET | Retrieve all job results
Parameters: jobName*: Job Name to be requested rfc3339: Return timestamps in RFC3339 format (true /false) start_time: Timestamp of first execution entry end_time: Timestamp of last execution entry |
| /scheduler/job/{jobName}/result/{jobId} | DELETE | Delete a specific job result
Parameters: jobName*: Job Name to be requested jobId*: Job id of execution result to be requested |
| GET | Retrieve a specific job result
Parameters: jobName*: Job Name to be requested jobId*: Job id of execution result to be requested |
|
| /scheduler/jobs | GET | Retrieve a list of active job names known by Adabas Interface
Parameters: No parameters |
| /scheduler/results | GET | Retrieve a specific job result
Parameters: from: Start time from to: End time to |
| Endpoint | Method | Description |
|---|---|---|
| /adabas/rest/access/{role} | GET | Retrieve the list of users who are allowed to access data
Parameters: role*: Access to role information for users or administrators. (Available values: User, user, USER, Administrator, administrator, ADMINISTRATOR) |
| POST | Insert user into the list of users who are allowed to access data
Parameters: role*: Access to role information for users or administrators. (Available values: User, user, USER, Administrator, administrator, ADMINISTRATOR) user*: New user to be added |
|
| DELETE | Delete user into the list of users who are allowed to access
data
Parameters: role*: Access to role information for users or administrators. (Available values: User, user, USER, Administrator, administrator, ADMINISTRATOR) user*: User to deleted |
| Endpoint | Method | Description |
|---|---|---|
| /binary/db/{dbid}/{file}/{isn}/{field} | GET | Retrieve a lob of a specific ISN of a field
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: Database file isn*: Specific ISN number field*: Specific the field to be reference: Remote node reference mimetype: Specific the data MIME type search: search criterium |
| PUT | Set a lob at a specific ISN of a field in a Map
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: Database file isn*: Specific ISN number field*: Specific the field to be reference: Remote node reference uploadLob*: Upload raw binary content of field |
|
| /image/db/{dbid}/{file}/{isn}/{field} | GET | Retrieve a field of a specific ISN of a Map definition
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: Database file isn*: Specific ISN number field*: Specific the field to be reference: Remote node reference search: search criterium |
| /rest/db | GET | Retrieve a list of known databases.
Parameters: No parameter |
| /rest/db/{dbid} | GET | Retrieve a list of files contained in the given database
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> reference: Remote node reference |
| /rest/db/{dbid}/{file} | GET | Get database records of a given database and file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number fields: A comma separated list of fields which should be in result (Default value: *) start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium reference: Remote node reference compact: Return result in compact structure(true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| POST | Insert database record
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number reference: Remote node reference data*: Data content. Please refer to the example value in the Swagger API |
|
| PUT | Update record data
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number reference: Remote node reference data*: Data content. Please refer to the example value in the Swagger API |
|
| /rest/db/{dbid}/{file}/{isn} | GET | Retrieve database record(s) of a given ISN
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN number or “*” for all records reference: Remote node reference fields: A comma separated list of fields which should be in result (Default value: *) start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| POST | Insert database record at given ISN.
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN number to be inserted reference: Remote node reference data*: Data content. Please refer to the example value in the Swagger API |
|
| PUT | Update database record of a given ISN.
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN number to be updated reference: Remote node reference data*: Data content. Please refer to the example value in the Swagger API |
|
| DELETE | Delete a specific ISN
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN of the record to be deleted reference: Remote node reference |
|
| /rest/db/{dbid}/{file}/{isn}/{field} | GET | Retrieve a specific database record field data.
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN number or “*” for all records field*: Field to be read reference: Remote node reference start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| PUT | Update database record field
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number isn*: ISN number to be updated field*: Field to be updated reference: Remote node reference data*: Data content. Please refer to the example value in the Swagger API |
|
| /rest/fields/{dbid}/{file} | GET | Retrieve all fields of an Adabas file
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: File number |
| /video/db/{dbid}/{file}/{isn}/{field} | GET | Retrieve a video stream of a specific ISN of a Map definition
Parameters: dbid*: Database ID or ADATCP or ADATCPS short reference like adatcp:<host>:<port> file*: Database file isn*: Specific ISN number field*: Specific the field to be streamed reference: Remote node reference mimetypeField*: Specific the field containing the mimetype search: search criterium |
| Endpoint | Method | Description |
|---|---|---|
| /binary/map/{name}/{isn}/{field} | GET | Retrieve a lob of a specific ISN of a field in a Map
Parameters: name*: Map definition name isn*: Specific ISN number field*: Specific the field to be mimetype: Specific the data MIME type search: search criterium |
| PUT | Set a lob at a specific ISN of a field in a Map
Parameters: name*: Map name isn*: Specific ISN number field*: Specific the field to be uploadLob*: Upload raw binary content of field |
|
| /image/map/{name}/{isn}/{field} | GET | Retrieve a field of a specific ISN of a Map definition
Parameters: name*: Map name isn*: Specific ISN number field*: Specific the field to be search: search criterium |
| PUT | Upload a LOB date to the given database field
Parameters: name*: Map name isn*: Specific ISN number field*: Specific the field to be uploadImage*: Upload image |
|
| /rest/map | GET | Retrieve a list of available maps
Parameters: No parameters |
| POST | Store send records into Map definition
Parameters: data: The file to upload |
|
| /rest/map/{name} | GET | Retrieve all records of a Map definition
Parameters: name*: Map definition name fields: A comma separated list of fields which should be in the result (Default value: *) start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| POST | Store send records into Map definition
Parameters: name*: Map definition name data*: Data content. Please refer to the example value in the Swagger API |
|
| PUT | Update send records into a Map definition
Parameters: name*: Map definition name data*: Data content. Please refer to the example value in the Swagger API |
|
| /rest/map/{name}/{isn} | GET | Retrieve all records of specific ISN in a Map definition
Parameters: name*: Map definition name isn*: Specific ISN number or “*” for all ISN fields: A comma separated list of fields which should be in result (Default value: *) start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| POST | Insert a new records of a Map definition
Parameters: name*: Map definition name isn*: Specific ISN number or “*” for all ISN data*: Data content. Please refer to the example value in the Swagger API |
|
| PUT | Update a record of a Map definition
Parameters: name*: Map definition name isn*: Specific ISN number or “*” for all ISN fields: A comma separated list of fields which should be in result (Default value: *) start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) exchange: Exchange current input data with record (true/false) xmlnotation: Use XML notation namespace (true/false) data*: Data content. Please refer to the example value in the Swagger API |
|
| DELETE | Delete a record of Map definition
Parameters: name*: Map definition name isn*: Specific ISN number or “*” for all ISN |
|
| /rest/map/{name}/{isn}/{field} | GET | Retrieve a field of a specific ISN of a Map definition
Parameters: name*: Map definition name isn*: Specific ISN number or “*” for all ISN field*: Specific a comma separated list of fields to be part of the result record start: Start offset where the read will start from (Default value: 0) limit: Maximal number of records retrieved (Default value: 20) sorted_by: Sort criterium search: Search criterium compact: Return result in compact structure (true/false) flatten: Remove database group tree entries in result records (true/false) descriptor: Read a descriptor read with the given field entry (true/false) xmlnotation: Use XML notation namespace (true/false) |
| /rest/metadata/map/{name} | GET | Retrieve metadata of a Map definition
Parameters: name*: Map definition name |
| /video/map/{name}/{isn}/{field} | GET | Retrieve a video stream of a specific ISN of a Map definition
Parameters: name*: Map definition name isn*: Specific ISN number field*: Specific the field to be mimetype: Specific the data MIME type mimetypeField*: Specific the field containing the mimetype search: search criterium |
| Endpoint | Method | Description |
|---|---|---|
| /file/access/{location} | GET | Download a file out of file location
Parameters: location*: Identifier of the file location file*: Identifier of the file location |
| POST | Upload a new file to the given location
Parameters: location*: Identifier of the file location file*: Identifier of the file location fileUpload*: Upload file |
|
| PUT | Create a new directory
Parameters: Ffile*: Identifier of the file location location*: Identifier of the file location |
|
| DELETE | Delete the file on the given location
Parameters: location*: Identifier of the file location file*: Identifier of the file location |
|
| /file/browse | GET | Retrieve a list of browsable locations
Parameters: No parameters |
| /file/browse/{location} | GET | Retrieve a list of files in the defined location.
Parameters: location*: Identifier of the file location file: Identifier of the file location |
| Endpoint | Method | Description |
|---|---|---|
| /redirect/{name} | GET | Redirect to remote cluster entry
Parameters: name*: Name of the node x*: Destination path |
| POST | Store configuration
Parameters: name*: Name of the node x*: Destination path |
|
| PUT | Store configuration
Parameters: name*: Name of the node x*: Destination path |
