URL Parameters

This article explains the parameters that you can add to the URL for GET, PUT, POST, and DELETE requests.
In this article:
Parameters for GET Requests
GET requests retrieve data from tables or resources. The result is an array of objects if successful, or an error object if not.
The following table lists the parameters that you can add to the URL for GET requests:
URL-encode all parameters.
Parameter Name
Description
Example
auth
The authentication token. Containing this parameter in the URL is a convenience so that you can do a GET from a web browser.
auth=demo_full:1
sysfilter
System filters help to protect the security of your data.
For more information about system filters, see Structured Filters.
Syntax:
sysfilter=[sysfiltername[modifier](expression[,expression])
Example:
.../Customer?sysfilter=equal(name: 'Jones')&
sysfilter=less(balance: 1000)
sysorder
System sorts help to protect the security of your data.
For more information about system sorts, see Structured Sorts.
Syntax:
sysorder=(expression[,expression])
Example:
.../Customer?sysorder=(name:null_first,balance:desc )
filter
Specifies a clause for the underlying query.
filter=name like 'Acme%' or balance > 999
Example if URL-encoded:
filter=name%20like%20'Acme%'%20or%20balance%20%3E%20999
order
One or more columns to sort by.
order=name,balance desc
pagesize
Determines the number of rows that
CA Live API Creator
returns at each level of a resource endpoint per request.
For more information about this API-level setting, see API Properties.
pagesize=100
offset
CA Live API Creator
generates this value for pagination in
next_batch
links.
We do not recommended that you contain this parameter in the URL. Row event and security affect this value so that it might not move in increments on
pagesize
.
offset=20
chunksize
Determines the number of queries
CA Live API Creator
executes to return the rows for table-based subresources.
To simplify the SQL for easier human consumption, set this parameter to 1 (one).
chunksize=2
logging
Sets the logging levels for this request only.
logging=buslog=DEBUG,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
parameter values take precedence over
inline
and
inlineamount
parameter values.
The value is also used for transaction summaries, but you must use database names.
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
parameter values take precedence over
inline
and
inlineamount
parameter values.
The value is also used for transaction summaries, but you must use database names.
inline=Cust.Address.Map
inlinelimit
This parameter overrides the
Inline Limit Default
API setting. The 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
parameter values take precedence over
inlinelimit
parameter values.
Values:
  • 0: Results in all non-null values returned as a link.
  • -1: Results in all values returned as a link.
inlinelimit=1000
responseformat
Specifies the format of the response. Valid values are:
  • json
  • xml
  • csv
    (comma-separated values)
You can set the response format using other methods, such as by using the Accept HTTP header or by setting the default response type for the API.
For more information:
  • About how to use the Accept HTTP header, see HTTP Headers.
  • About how to set the default response type for the API, see API Properties.
.../MyAPI/main:customer/123?responseformat=xml
For more information about GET calls, see GET.
Parameters for POST and PUT Requests
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.
The following table lists the parameters that you can add to the URL for POST and PUT requests:
Parameter name
Description
Example
logging
Sets the logging levels for this request only.
logging=buslog=DEBUG,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:
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
parameter values take precedence over
inline
and
inlineamount
parameter values.
The value is also used for transaction summaries, but you must use database names.
deferred=Cust.Orders.LineItem.Product.Photo,Cust.Orders.SalesRep.EmployeePicture
inline
Comma-separated list of
resource.attribute
names that is returned as
inline
parameter 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 you must use database names.
inline=Cust.Address.Map
inlineamount
This parameter overrides the
Inline Limit Default
API setting. The 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
parameter values 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 POST and PUT calls, see PUT.
Parameters for DELETE Requests
DELETE requests delete an object from a table or a resource.
Prerequisite:
You have specified a primary key in the URL.
The following table lists the parameters that you can add to the URL for DELETE requests:
Parameter name
Description
Example
checksum
(required)
The checksum for the object to be deleted (You can bypass optimistic locking using
override
).
checksum=954cc2f46ff16bb1
logging
Sets the logging levels for this request only.
logging=buslog=DEBUG,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:
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 values. API Server also uses this value for transaction summaries, but you must use database names.
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 you must use database names.
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
parameter values 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.