...
Note |
---|
Note! Temporary files are created on the Platform host when the user executes queries via Reference Data Management. These temporary files, which are stored in |
Restful Operations
The tables below describe the various operation operations that are available for Reference Data Management. The
The service endpoint URI is http://<Platform host>:<port>/api/v1.
If encryption is enabled, the URI is https://<Platform host>:<port>/api/v1
.
For further information about enabling encryption, see Network Security in the System Administration userAdministrator's guideGuide.
Basic authentication is used and you must pass user credentials for each RESTful call.
Create and Get Session
...
Resource path: /session
...
This operation returns a session id which should be appended to all subsequent API calls where this parameter is applicable.
Resource path | /session |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example
|
Close Session
...
Resource path: /session/close?sessionid=<sessionid>
...
This operation closes a session. This session id is no longer valid for any subsequent API calls.
...
Resource path | /session/close?sessionid=<sessionid> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Closing a session
|
Get Reference Data Profiles
...
Resource path: /refdatas
...
This operation retrieves a list of all Reference Data profiles that are available to the user.
...
Resource path |
---|
...
Example - Retrieving a list
/refdatas | |
HTTP method | GET |
---|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Retrieving a list
|
Get Metadata
...
Resource path: /refdatas/<Reference Data profile>/table/<table name>?sessionid=<session id>
...
This operation retrieves table metadata that can be used for grid configuration, export, and Import configuration etc. If viewing or to derive parameters for other REST APIs. If the Last Update feature is enabled, the values stored in the most recent Last Update user and timestamp column will be are retrieved as well. The result is returned synchronously.
...
Resource path | /refdatas/<Reference Data profile>/table/<table name>?sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get metadata
|
Get Query
Resource path: /refdatas/<Reference Data profile>/table/<table name>/rowset?sessionid=<session id>
HTTP method: PUT
Resource path:
This operation This operation executes database queries on a specific a Reference Data profile and database table. The query is performed asynchronously and control is returned immediately. You can retrieve the result of the query by using /rowset/<rowset number>?sessionid=<session id>
. This operation requires JSON payload as input.
Info | ||||
---|---|---|---|---|
Example - Get query
example.json:
|
Get Data Sets
Resource path: /rowset/<rowset number>?sessionid=<session id>
HTTP method: GET
Data sets can be retrieved once downloaded to the file system of the Platform. This operation returns a data set for the given rowset (sequence number). The total number of available data sets can be queried with the status
operation.
...
Example - Get data sets
...
Input parameters that are passed in a JSON format as part of the HTTP message body.
Note |
---|
Note!Any ongoing query process running on the same session will be aborted and a new process for the latest query will be executed. This operation will clear any uncommitted changes saved in the same session. |
Resource path | /refdatas/<Reference Data profile>/table/<table name>/rowset?sessionid=<session id> |
---|---|
HTTP method | PUT |
Body | This is where the executeQuery is included. The executeQuery JSON payload includes these options:
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get query without query expression in JSON payload body
|
Get Status
Resource path: /status?sessionid=<session id>
HTTP method: GET
This operation returns a status message. It can be used to retrieve active processes and to query the number of available rows, data sets and status of imports and exports. If Last Update feature is enabled, the values stored in the most recent Last Update user and timestamp column will be retrieved as well.
Note |
---|
Note!The status is used by the Web UI to lock the interface during an active process. This prevents a user from initiating another operation before the first operation initiated is complete. However, |
Info | ||
---|---|---|
Example - Get status
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get query with query expression in JSON payload body
|
Abort process
Resource path: /status/abort?sessionid=<session id>
HTTP method: GET
This operation request the active process to abort.
Info | ||
---|---|---|
Example - Abort process
|
Table export
This operation performs a database table export. Input parameters are passed in a JSON format as part of the HTTP message body as a APPLICATION_FORM_URLENCODED string.
...
Parameters
...
Description
...
Value
...
Resource path
...
The path to where the resource is located
...
/refdatas/<Reference Data profile>/table/<table name>/download?sessionid=<sessionid>
...
HTTP method
...
The HTTP method of the export command.
...
POST
...
Basic Auth
...
This is a required parameter which contains the username and password.
...
user:passw
...
Body
...
This is where the exportParams will be included in url encoding. The exportParams format will include these optional options:
opts
textQualifier - designated as double quotes by default.
separator - designated as a comma by default.
extent - designated as all by default.
selectedColumns - allows for specific columns to be selected.
...
Example format: exportParams={"opts":{"textQualifier":"\'","separator":";","extent":"all"},"selectedColumns":["COLUMN1","COLUMN2"]}
exportParams=%7B%22opts%22%3A%7B%22textQualifier%22%3A%22%5C'\''%22%2C%22separator%22%3A%22%3B%22%2C%22extent%22%3A%22all%22%7D%2C%22selectedColumns%22%3A%5B%22CITY%22%2C%22CUSTOMER_NAME%22%5D%7D
Info | ||
---|---|---|
Example - Table export without options
|
Rw ui textbox macro | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Example - Get query using a JSON payload file
Example.json file
|
Get Data Sets
Data sets can be retrieved once downloaded to the file system of the Platform. This operation returns a data set for the given rowset (sequence number). The total number of available data sets can be queried with the Get Status
operation.
Resource path | /rowset/<rowset number>?sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get data sets
|
Get Status
This operation returns a status message. It can be used to retrieve active processes and to query the number of available rows, data sets, and the status of imports and exports. If the Last Update feature is enabled, the values stored in the most recent Last Update user and timestamp column are retrieved as well.
Resource path | /status?sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get status
| |||||
Info | |||||
Example - Table export with options
|
Abort Process
This operation requests the active process to abort.
Note |
---|
Note!To prevent a user from initiating another operation before the first operation initiated is complete, |
Resource path | /status/abort?sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Get status
|
Table Import
This operation performs a database table import. Input parameters are passed in a JSON format as part of the HTTP message body.
...
Parameters
...
Description
...
Value
...
Resource path
...
The path to where the resource is located
...
/refdatas/<Reference Data profile>/table/<table name>/upload?sessionid=<sessionid>
...
HTTP method
...
The HTTP method of the import command.
...
POST
...
Basic Auth
...
This is a required parameter which contains the username and password.
...
user:passw
...
File Input
...
This is where the file input will be included in url encoding. The exportParams format will include these optional opts:
textQualifier - designated as double quotes by default.
separator - designated as a comma by default.
append/truncate - designated as append by default. Changing to truncate will result in the existing data in the table to be truncated before the import is executed.
force - designated as false by default.
...
Example format: file=@/<path to csv file>/test.csv 'opts={"textQualifier":"\'","separator":",","op":"append","force":false}'
file=@/path/to/import_test.csv 'opts={"textQualifier":"\'","separator":",","op":"append","force":false}'
Info | ||
---|---|---|
Example - Table import without options
|
Table Export
This operation performs a database table export. Input parameters are passed in a JSON format as part of the HTTP message body.
Resource path | /refdatas/<Reference Data profile>/table/<table name>/download?sessionid=<sessionid> | ||
---|---|---|---|
HTTP method | POST | ||
Body | This is where the exportParams are included. The exportParams JSON payload includes these options:
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Table export without options
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Table export with options
| |||||
Info | |||||
Example - Table import with options
|
Save Changes
Resource path: /save?sessionid=<session id>
HTTP method: PUT
This operation saves data grid edit modification (post insert/update/delete). Changes are saved within client session. This operation requires JSON payload as input.
Note |
---|
Note!
|
Note |
---|
Note!The save operation is supported either on Oracle (based on ROWID pseudo column) or non-Oracle type tables containing Primary Key constraint. Non-Oracle tables without a Primary Key are not supported for data modifications. |
Info | ||||
---|---|---|---|---|
Example - Save changes
example.json:
|
Commit Changes
Resource path: /save/commit?force=<true|false>&sessionid=<session id>
HTTP method: GET
This operation applies saved edits in the database and commits the work in case of success. You can use "force" commit in case of errors.
Info | ||
---|---|---|
Example - Commit changes
|
List Changes
Resource path: /save/list?sessionid=<session id>
HTTP method: GET
This operation returns a list of the modifications saved. You can use this operation to reapply changes in the Web UI during a grid refresh.
Info | ||
---|---|---|
Example - List changes
|
Cancel Changes
Resource path: /save/cancel?sessionid=<session id>
HTTP method: PUT
This operation cancels the changes made from being saved. As the input, Json payload specifies either all the changes to be canceled or lists the selected Primary Keys to be cancelled. You can cancel the saving of several changes at the same time (one Primary Key per change). The scope is single or all. The format is the same as for the Save changes operation but the ID fields are stored in a root structure. Ids are in a JSON array to hold multiple Primary Keys to be cancelled.
Note |
---|
Note!The Web UI generates surrogate Primary Keys for inserted rows for the cancel function. |
Info | ||||||
---|---|---|---|---|---|---|
Example - Cancel changes
example.json:
Example response:
|
Note |
---|
Note!
|
Show Demo Query
Resource path: /demo/queryRequestParameters
HTTP method: GET
This operation shows the json payload format that applies for a query operation e g rowset/.
Show Demo Changes
Resource path: /demo/dataEditRequestParameters
HTTP method: GET
...
|
Table Import
This operation performs a database table import. Input parameters are passed in a JSON format as part of the form-data in the HTTP message body.
Resource path | /refdatas/<Reference Data profile>/table/<table name>/upload?sessionid=<sessionid> |
---|---|
HTTP method | POST |
Body | This is where the file and the input parameters are included. The exportParams format includes these options:
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Table import without options
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Table import with options
|
Save Changes
This operation saves data modification (insert/update/delete). Changes are saved within the client session. Input parameters are passed in a JSON format as part of the HTTP message body.
Note |
---|
Note!
|
Note |
---|
Note!The save operation is supported either on Oracle (based on the ROWID pseudo column) or non-Oracle type tables containing a Primary Key constraint. Non-Oracle tables without a Primary Key are not supported for data modifications. |
Resource path | /save?sessionid=<session id> | ||
---|---|---|---|
HTTP method | PUT | ||
Body | This is where the dataEdits are included. The dataEdit JSON payload includes these options:
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Save changes with a JSON payload body
|
Rw ui textbox macro | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Example - Save changes using a JSON payload file
Example.json
|
Commit Changes
This operation applies saved edits in the database and commits the work in case of success. You can use force
commit in case of errors. If the Last Update feature is enabled, the user name and modification timestamp values for insert/update modifications are stored in the Last Update columns specified in the Reference Data Management Profile. The Last Update information is used by the Get Status
operation to retrieve the most recent Last Update user and timestamp.
Resource path | /save/commit?force=<true|false>&sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Commit changes
|
List Changes
This operation returns a list of the modifications saved.
Resource path | /save/list?sessionid=<session id> |
---|---|
HTTP method | GET |
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - List changes
|
Cancel Changes
This operation cancels the changes made from being saved. Input parameters are passed in a JSON format as part of the HTTP message body.
Note |
---|
Note!Pseudo Primary Keys for inserted rows can be included in the |
Note |
---|
Note!
|
Resource path | /save/cancel?sessionid=<session id> |
---|---|
HTTP method | PUT |
Body | This is where the dataEdits are included. The dataEdit JSON payload includes these options:
|
Rw ui textbox macro | |||||
---|---|---|---|---|---|
| |||||
Example - Cancel changes
|
Show Demo Query
This operation shows an example JSON payload format that applies for a Get Query
operation.
Resource path | /demo/queryRequestParameters |
---|---|
HTTP method | GET |
Show Demo Changes
This operation shows an example JSON payload format that applies for a Save Changes
operation.
Resource path | /demo/dataEditRequestParameters |
---|---|
HTTP method | GET |