Filters

GET

GET requests retrieve data from a table or resource. The result is an array of objects if successful, or an error object if not.The URL may contain any of the following parameters after a question mark. Note that all parameters must be URL-encoded.

Parameter nameDescriptionExample
authAPI key: this is a convenience so you can do a GET from a web browser.auth=demo_full:1
filterSpecifies a clause for the underlying queryfilter=name like 'Acme%' or balance > 999 
Once URL-encoded, this would look like:filter=name%20like%20'Acme%'%20or%20balance%20%3E%20999
orderOne or more columns to sort byorder=name,balance desc
pagesizeSets the number of objects to retrieve in one batch. The default is 20. You cannot make this number smaller than 1, or larger than 1,000.pagesize=100
offsetThis is generated internally for pagination in next_batch links. It is not recommended to set this manually, as security and JavaScript filters can make this value jump by more than pagesize for each page.offset=20
chunksizeAn advanced tuning parameter, used to control SQL generation, normally defined at a project level. On occassion, it may be useful to set to 1 (one) to simplify the SQL for easier human consumption.chunksize=2
loggingSets the logging levels for this request onlylogging=buslog=FINE,persis=FINEST
debugIf true, all JavaScript are executed in debug mode.debug=true
downloadNameUsed to specified download name.downloadName=Foo.json
deferredComma-separated list of Resource.attribute names that is returned as deferred links. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
deferred=Cust.Orders.LineItem.Product.Photo,Cust.Orders.SalesRep.EmployeePicture
inlineComma-separated list of Resource.attribute names that is returned as inline values. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
inline=Cust.Address.Map
inlineamount

Overrides the project setting. Number of characters or bytes used to decide whether a value is returned inline in the JSON or deferred to a link for BINARY or STRING data.
both 'deferred' and 'inline' take precendence over 'inlineamount' values.
A value of 0 results in ALL non-null values returned as a link. A value of -1 results in all values returned as a link.

inlineamount=1000
POST and PUT

POST requests insert one or more objects into a table or a resource. PUT requests update one or more object. POST and PUT requests must have a body consisting of either one object, or an array of objects. POST and PUT requests can have the following parameters:

Parameter nameDescriptionExample
loggingSets the logging levels for this request onlylogging=buslog=FINE,persis=FINEST
debugIf true, all JavaScript logic is executed in debug mode.debug=true
txsummaryIf true, the response includes a description of all database objects updated during the transaction. Default value is 'true'.txsummary=false
rulesummaryIf true, the response includes a description of all the rules executed during the transaction.rulesummary=true
deferredComma-separated list of Resource.attribute names that is returned as deferred links. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
deferred=Cust.Orders.LineItem.Product.Photo,Cust.Orders.SalesRep.EmployeePicture
inlineComma-separated list of Resource.attribute names that is returned as inline values. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
inline=Cust.Address.Map
inlineamountOverrides the project setting. Number of characters or bytes used to decide whether a value is returned inline in the JSON or deferred to a link for BINARY or STRING data. 
both 'deferred' and 'inline' take precendence over 'inlineamount' values. 
A value of 0 results in ALL non-null values returned as a link. A value of -1 results in all values returned as a link.
inlineamount=1000

DELETE

DELETE requests delete an object from a table or a resource. A primary key must always be specified in the URL. The following parameters can be added to the URL:

Parameter nameDescriptionExample
checksum(required)The checksum for the object to be deleted (can be override to bypass optimistic locking)checksum=954cc2f46ff16bb1
loggingSets the logging levels for this request onlylogging=buslog=FINE,persis=FINEST
debugIf true, the JavaScript logic is executed in debug mode.debug=true
txsummaryIf true, the response includes a description of all database objects updated during the transaction. Default value is 'true'.txsummary=false
rulesummaryIf true, the response includes a description of all the rules executed during the transaction.rulesummary=true
deferredComma-separated list of Resource.attribute names that are returned as deferred links. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
deferred=Cust.Orders.LineItem.Product.Photo,Cust.Orders.SalesRep.EmployeePicture
inlineComma-separated list of Resource.attribute names that are returned as inline values. This applies only to BINARY and STRING data. 
'deferred' values take precedence over 'inline' and 'inlineamount' values. 
The value is also used for transaction summaries, but database names must be used.
inline=Cust.Address.Map
inlineamountOverrides the project setting. Number of characters or bytes used to decide whether a value is returned inline in the JSON or deferred to a link for BINARY or STRING data. 
both 'deferred' and 'inline' take precendence over 'inlineamount' values. 
A value of 0 results in ALL non-null values returned as a link. A value of -1 results in all values returned as a link.
inlineamount=1000
Comments