Versions Compared

Old Version 26

changes.mady.by.user Yuri Au Yong

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 $MZ_HOME/tmp/rowset, are removed automatically when the user session expires. Users User sessions expire automatically after six (6) hours.

...

The tables below describe the various operation operations that are available for Reference Data Management. 

...

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.

...

This operation retrieves table metadata that can be used for 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.

...

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 Input parameters that are passed in a JSON format as part of the HTTP message body.

...

Resource path

/refdatas/<Reference Data profile>/table/<table name>/rowset?sessionid=<session id>

HTTP method

PUT

Body

This is where the executeQuery will be is included. The executeQuery JSON payload will include includes these options:

  1. rowsPerPage - the max number of rows (Data Set size) that can be are allowed in a rowset of the retrieved result.

  2. selectedColumns - allows for specific columns to be selected.

  3. filterExpression - allows optional definition of query expressions. The query will match all of the specified query expressions.

...

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 will be are retrieved as well.

Resource path

/status?sessionid=<session id>

HTTP method

GET

...

Abort Process

This operation request requests the active process to abort.

...

Resource path

/refdatas/<Reference Data profile>/table/<table name>/download?sessionid=<sessionid> 

HTTP method

POST

Body

This is where the exportParams will be are included. The exportParams JSON payload will include includes these options:

  1. opts

    1. textQualifier - designated as double quotes by default.

    2. separator - designated as a comma by default.

    3. extent - designated as all by default.

      1. all - export all rows in the table.

      2. selected - export rows from the result of Get Query.

  2. selectedColumns - allows for specific columns to be selected.

Note

Note!

For the extend option, selected value is only applicable when Get Query is applied prior Table Export. 

...

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 will be are included. The exportParams format will include includes these optional optsoptions:

  1. textQualifier - designated as double quotes by default.

  2. separator - designated as a comma by default.

  3. opts - designated as append by default.

    1. append - import imported rows will be are appended to the table.

    2. truncate - the existing data in the table will be are truncated before the import is executed.

  4. force - designated as false by default.

...

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!

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 dataEdit will be dataEdits are included. The dataEdit JSON payload will include includes these options:

  1. refProfile - Reference Data Management Profile.

  2. tableName - Database table name.

  3. updates - modification parameters.

    1. action - to specify the type of modification.

      1. insert - insert a new row to the table.

      2. update - edit an existing row in the table.

      3. delete - delete an existing row in the table.

    2. ids - to specify column value pairs of primary key(s).

      1. column - private key column name.

      2. value - private key value for the respective column.

    3. values - to specify column value pairs to be inserted/updated.

      1. column - column name to be inserted/updated.

      2. value - insert/update value for the respective column.

Note

Note!

When insert inserting a row, specifying a pseudo ids column value pair allows Cancel Changes to be applied on to that specific insert row modification.

...

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 will be are stored in the Last Update columns specified in the Reference Data Management Profile. The Last Update information will be is used by the Get Status operation to retrieve the most recent Last Update user and timestamp.

...

Note

Note!

Pseudo Primary Keys for inserted rows can be included in the Save Changes operation to allow the cancel function on for a specific insert row modification. 

...

Resource path

/save/cancel?sessionid=<session id>

HTTP method

PUT

Body

This is where the dataEdit will be dataEdits are included. The dataEdit JSON payload will include includes these options:

  1. scope - specify the scope of changes to be canceled.

    1. single - allow only specific modifications identified by ids to be cancelled.

    2. all - allow all the modifications to be canceled.

  2. ids - to specify column value pairs of primary key(s). This is only required when the scope is single.

    1. column - private key column name.

    2. value - private key value for the respective column.

Rw ui textbox macro
typetip

Example - Cancel changes

Code Block
languagebash
$ curl -u user:passw -H 'content-type: application/json' \
-d '{"dataEdit":{"scope":"single","ids": [{"id":[{"column":"ORDER_NUM","value":10398005}]}] \
http://localhost:9000/api/v1/save/cancel?sessionid=vusncl88sjghv7h8nkb0ohja6t

...

This operation shows an example json JSON payload format that applies for a Get Query operation. 

...

Show Demo Changes

This operation shows and an example json JSON payload format that applies for a Save Changes operation. 

...