Versions Compared

Old Version 16

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version 17

changes.mady.by.user Tracy McCurdy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.

ParameterRequiredTypeDescription
${returnType}YesstringSpecifies the format in which data should be returned. The format can be one of the following: json, csv, xls or pdf.
fieldsVisibility Nojson/string
Specifies field visibility settings, for example:
Code Block
linenumberstrue
{ "lsid": "1", "lsn": "1", "lsh": "1", "lsp": "1", "lsd": "1", "vn": "1", "gtn": "1"}

where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.
filterNojson/string

Applies filtering to narrow down the results.

To filter by a string column, use the following format: 

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "type": "string",
        "field": "${lsn | lsh | lsd | vn | gtn}",
        "value": "${value}"
    }
]

To filter by a numeric column, use the following format: 

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsid | lsp}",
        "value": "${value}"
    }
]


limitNointegerSpecifies the number of records that must be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

Specifies the field by which you want to order your data records. The field name can be one of the following: 

lsid, lsn, lsh, lsp, lsd, vn, gtn
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...