Invoking APIs‎ > ‎

URL Parameters

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. You must URL-encode all parameters.

Parameter name Description Example
auth API key. This is a convenience so you can do a GET from a web browser. auth=demo_full:1
sysfilter Structured filters provide SQL injection protection.

For more information about structured filters, see Structured Filters.
.../Customer?sysfilter=equal(name: 'Jones')&
sysfilter=less(balance: 1000)
sysorder Structured sorts provide SQL injection protection.

For more information about structured sorts, see Structured Sorts.
.../Customer?sysorder=(name:null_first,balance:desc )
filter Specifies a clause for the underlying query. filter=name like 'Acme%' or balance > 999 
Once URL-encoded, this would look like:filter=name%20like%20'Acme%'%20or%20balance%20%3E%20999
order One or more columns to sort by. order=name,balance desc
pagesize Sets the number of objects to retrieve in one batch. Default: 20
Limits: 1 - 1,000

For more information, see Pagination.
pagesize=100
offset This 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
chunksize An 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
logging Sets the logging levels for this request only. logging=buslog=FINE,persis=FINEST
debug If true, all JavaScript are executed in debug mode. debug=true
downloadName Used to specified download name. downloadName=Foo.json
deferred Comma-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
inline Comma-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
For more information about GET calls, see GET.
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 name Description Example
logging Sets the logging levels for this request only. logging=buslog=FINE,persis=FINEST
debug If true, all JavaScript logic is executed in debug mode. debug=true
txsummary If true, the response includes a description of all database objects updated during the transaction. Default value is 'true'. txsummary=false
rulesummary If true, the response includes a description of all the rules executed during the transaction. rulesummary=true
deferred Comma-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
inline Comma-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

For more information about POST and PUT calls, see POST and PUT.

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 name Description Example
checksum(required) The checksum for the object to be deleted (You can override to bypass optimistic locking). checksum=954cc2f46ff16bb1
logging Sets the logging levels for this request only. logging=buslog=FINE,persis=FINEST
debug If true, the JavaScript logic is executed in debug mode. debug=true
txsummary If true, the response includes a description of all database objects updated during the transaction. Default value is 'true'. txsummary=false
rulesummary If true, the response includes a description of all the rules executed during the transaction. rulesummary=true
deferred Comma-separated list of Resource.attribute names that are returned as deferred links. This applies only to BINARY and STRING data. deferred parameter values take precedence over inline and inlineamount parameter valuesThe value is also used for transaction summaries, but database names must be used. deferred=Cust.Orders.LineItem.Product.Photo,Cust.Orders.SalesRep.EmployeePicture
inline Comma-separated list of Resource.attribute names that are returned as inline values. This applies only to BINARY and STRING data. deferred parameter values take precedence over inline and inlineamount parameter 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. deferred and inline parameters take precedence over inlineamount parameter values.
Values:
  • 0 - Results in all non-null values returned as a link.
  • -1 - Results in all values returned as a link.
inlineamount=1000
For more information about DELETE calls, see DELETE.