Versions Compared

Old Version 5

changes.mady.by.user Kevin Wu

Saved on

compared with

New Version 6

changes.mady.by.user Kevin Wu

Saved on

Key

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

...

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. 

ParametersDescriptionValue
Resource pathThe path to where the resource is located/refdatas/<Reference Data profile>/table/<table name>/download?sessionid=<sessionid> 
HTTP methodThe HTTP method of the export command.POST
Basic Auth

This is a required parameter which contains the Image Modified 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:

  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.
  2. 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
titleExample - Table export without options


Code Block
## exportParams={}

curl -X POST \
'http://localhost:9000/api/v1/refdatas/ref_data_mgmt_oracle.ref_data_mgmt_pf/table/TABLE.CUSTOMERS/download?sessionid=p3hce86dkb4rmls9peh4e8rps9' \
-u "user:passw" \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'exportParams=%7B%7D' \
> Export.csv


...