returnColumns
Columns to include in the response output. The <DATA> tag in the response contains the data values from the object. If returnColumns is not specified, no <DATA> tags are included in the response. Audit columns, logical columns (multi-select), and CLOB columns cannot be returned.
Note:
In releases 9.7 and lower, the DATA section of the REST response only includes records for insert and update DML actions.
The syntax is objectname=columnname for each object and column to retrieve. Separate physical column names by commas. To return all columns specify All. This parameter has is no default value.
Data objects.
returnColumns=COL1,COL2. To return all columns,
returnColumns=All.
Conceptual objects. For example, where objects are co_obj1 and co_obj2, and columns are COL1, COL2, COL3: Return some columns:
returnColumns=co_obj1=COL1;co_obj2=COL2,COL3. Return all columns,
returnColumns=co_obj1=All;co_obj2=All decode does not apply to reference columns; therefore, the XML format is the same as when decode=false.
For a data object, the number of data object tags in the <DATA> tag varies based on the batch size. That is, if the batch size=100 (default value) and 200 records are inserted, there are two <State> tags for a successful execution flow. If an error occurs, then each record retriggered from the exception queue will be in a separate data object name tag.
The following is an example of the XML returned.
<?xml version="1.0" encoding="UTF-8" ?>
<OUTPUT>
<IDENTIFIER>447426</IDENTIFIER>
<RESULT>
<DATA>
<State>
<datarow>
<STATE_ID>3001</STATE_ID>
<STATE_NAME>State_Name_1</STATE_NAME>
</datarow>
<datarow>
<STATE_ID>5001</STATE_ID>
<STATE_NAME>State_Name_2</STATE_NAME>
</datarow>
</State>
</DATA>
<MESSAGE>Process finished successfully.</MESSAGE>
<STATUS>Success</STATUS>
<DETAILS>
<![CDATA[ Total records inserted/updated: 10 The process finished
successfully. Elapsed time: 1 s ]]>
</DETAILS>
</RESULT>
</OUTPUT>
For a conceptual object, the number of data object name tags varies for each constituent object that is inserted or updated.
<?xml version="1.0" encoding="UTF-8" ?>
<OUTPUT>
<IDENTIFIER>447426</IDENTIFIER>
<RESULT>
<DATA>
<country>
<datarow>
<COUNTRY_ID >3001</COUNTRY_ID>
<COUNTRY_NAME>Country_Name_1</COUNTRY_NAME>
</datarow>
</country>
<state>
<datarow>
<STATE_ID>3001</STATE _ID>
<STATE_NAME>State_Name_1</STATE_NAME>
</datarow>
</state>
<city>
<datarow>
<CITY_ID>3001</CITY_ID>
<CITY_NAME>City_Name_1</CITY _NAME>
</datarow>
</city>
</DATA>
<MESSAGE>Process finished successfully. </MESSAGE>
<STATUS>Success</STATUS>
<DETAILS>
<![CDATA[ Total records inserted/updated: 10 The process finished
successfully. Elapsed time: 1 s ]]>
</DETAILS>
</RESULT>
</OUTPUT>
To obtain service audit log information, ensure that you specify returnColumns for onedata.webservice.rest.responseLogLevel log levels 1, 2, and 6. For more information about the webMethods OneData configuration property, see Administering webMethods OneData.