Class Index | File Index

Classes


Class LABKEY.Query.ModifyRowsOptions

ModifyRowsOptions class to describe the third object passed to the successCallback function by LABKEY.Query.updateRows, LABKEY.Query.insertRows or LABKEY.Query.deleteRows. This object's properties are useful for matching requests to responses, as HTTP requests are typically processed asynchronously.

Additional Documentation:


Defined in: Query.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
An object containing one property for each HTTP header sent to the server.
 
The data object sent to the server.
 
The HTTP method used for the request (typically 'GET' or 'POST').
 
url
The URL that was requested.
Class Detail
LABKEY.Query.ModifyRowsOptions()
See:
LABKEY.Query.updateRows
LABKEY.Query.insertRows
LABKEY.Query.deleteRows
Field Detail
{Object} headers
An object containing one property for each HTTP header sent to the server.

{Object} jsonData
The data object sent to the server. This will contain the following properties:

For LABKEY.Query.updateRows:

For the 'updateRows' method, each row in the rows array must include its primary key value as one of its fields.

An example of a ModifyRowsOptions object for the 'updateRows' successCallback:

 {"schemaName": "lists",
  "queryName": "API Test List",
  "rows": [
 {"Key": 1,
 "FirstName": "Z",
 "Age": "100"}]
 } 

For LABKEY.Query.insertRows:

For the 'insertRows' method, the fields of the rows should look the same as they do for the 'updateRows' method, except that primary key values for new rows need not be supplied if the primary key columns are auto-increment.

An example of a ModifyRowsOptions object for the 'insertRows' successCallback:

 {"schemaName": "lists",
  "queryName": "API Test List",
  "rows": [
  {"FirstName": "C",
 "Age": "30"}]
 } 

For LABKEY.Query.deleteRows:

For the 'deleteRows' method, the fields of the rows should look the same as they do for the 'updateRows' method, except that the 'deleteRows' method needs to supply only the primary key values for the rows. All other row data will be ignored.

An example of a ModifyRowsOptions object for the 'deleteRows' successCallback:

 {"schemaName": "lists",
  "queryName": "API Test List",
  "rows": [
{"Key": 3}]
 } 

{String} method
The HTTP method used for the request (typically 'GET' or 'POST').

{String} url
The URL that was requested.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 16 2017 20:36:36 GMT-0000 (UTC)