Page Comparison

...

This operation executes database queries on 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. The rowsPerPage value is the max number of rows(Data Set size) that can be in a rowset of the retrieved result.

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 will be included. The executeQuery JSON payload format will include these options:

rowsPerPage - the max number of rows(Data Set size) that can be in a rowset of the retrieved result.
selectedColumns - allows for specific columns to be selected.

Rw ui textbox macro

type	tip

Example - Get query with JSON payload in the HTTP message body

Code Block

language	bash

$ curl -X PUT -T="example.json" -u user:passw \
http://localhost:9000/api/v1/refdatas/Default.refprofile_star/table/APP.STAR/rowset? \
sessionid=vusncl88sjghv7h8nkb0ohja6t \
-d '{"executeQuery": {"rowsPerPage":500,"selectedColumns":["ID","FIRSTNAME","LASTNAME"]}}'

Rw ui textbox macro

type	tip

Example - Get query using a JSON payload file

Code Block

language	bash

$ curl -X PUT -T="Example.json" -u user:passw \
http://localhost:9000/api/v1/refdatas/Default.refprofile_star/table/APP.STAR/rowset? \
sessionid=vusncl88sjghv7h8nkb0ohja6t

Example.json file

Code Block

language	json

{
	"executeQuery": {
		"rowsPerPage": 1024,
		"tableName": "APP.STAR"": 500,
		"selectedColumns": ["ID", "FIRSTNAME", "LASTNAME"]
	}
}

...

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!

...

, the values stored in the most recent Last Update user and timestamp column will be retrieved as well.

Resource path	/status?sessionid=<session id>
HTTP method	GET

...

This operation request the active process to abort.

Note

Note!

To prevent a user from initiating another operation before the first operation initiated is complete, Abort process can be used before an operation is complete.

Resource path	/status/abort?sessionid=<session id>
HTTP method	GET

...

Versions Compared

Old Version 20

New Version 21

Key

Note!

Example - Get query with JSON payload in the HTTP message body

Example - Get query using a JSON payload file

Example.json file

Note!

Note!