API Reference

Support : API Reference
Retrieve Data - Parameters
itemrefs

A comma delimited list of item refs to retrieve. See the Item Refs article for more information about item refs.

sortitemrefs

A comma delimited list of item refs to sort by. See the Item Refs article for more information about item refs. Prefix an item ref with a minus sign to denote a descending sort.

summaryitemrefs

A comma delimited list of item refs to summarize the data by. See the Item Refs article for more information about item refs.

translatevalueforitems

A comma delimited list of item refs which should be translated to the current language if a translation is present. See the Item Refs article for more information about item refs.

includekeyitems

True or False to indicate whether key items should be returned even if they have not been requested specifically.

includeforeignkeyitems

True or False to indicate whether foreign key items should be returned even if they have not been requested specifically.

includetimestamp

True or False to indicate whether the timestamp item should be returned even if it has not been requested specifically.

perpage

A number to indicate the maximum number of rows to retrieve in this call. The default is 100.

page

A number to indicate the specific page of data to retrieve in this call. The default is 1.

includeadditionalmetadata

True or False to indicate whether additional meta data for isKeyItemInd, canChangeOnUpdateInd, canIncludeOnInsertInd, canIncludeOnDeleteInd, and isTimestampItemInd should be included in the response. Item meta data for itemRef, itemName, and itemType are always present.

filter

One or more criteria pairs to be used to select specific data. For example: filter=settlementdate.ge.fnSubtractDays(fnUTCDateTime(),7).and.settlementstatuscode.eq.P

A filter can include and / or logic, brackets, and functions.

Try out the API builder which will help to easily format correct item references, functions and filters.