Using Mode
The mode key allows you to run queries to retrieve data in asynchronous, synchronous ways and BLOB/CLOB datatypes. Mode allows below values.
- SYNC - This is the default mode and it will return data immediately in response. If blob columns exist in the user request, it will throw the error with the "BLOB/CLOB Columns are not supported in ASYNC and SYNC mode" message.
- ASYNC - This will allow endpoint point to run asynchronously and returns jobId in response. If blob columns exist in the user request, it will throw the error with the "BLOB/CLOB Columns are not supported in ASYNC and SYNC mode" message
- BLOB_COLUMNS - This will allow fetching BLOB/CLOB datatypes asynchronously and returns jobId in response. If non-blob columns exist in the user request, a combination of those column values will be used as a blob/clob file name.
ASYNC Mode Example
Request
{ "name": "My Activities", "mode": "ASYNC", "tables": [ { "tableName": "TASK", "columns": [ "PROJ_ID", "TASK_ID", "TASK_NAME", "TASK_TYPE", "STATUS_CODE", "ACT_START_DATE", "ACT_END_DATE" ] } ] }
Response
{ "jobId": "a0e60f10-80f2-4c29-8ad0-9751b032bd3d" }
BLOB Columns Mode Example
Request
{ "name": "GCHANGE_DATA ", "mode": "BLOB_COLUMNS", "tables": [ { "tableName": "GCHANGE", "columns": [ "GCHANGE_NAME", "GCHANGE_DATA" ] } ] }
Response
{ "jobId": "be4c000e-3849-465a-928c-2211057dc068" }