./list/print

This method permits to export data in either Excel, JSON or XML format.

The JSON format slightly differs from the result returned by ./list. See at the end of this page.

URL

(POST) ./list/print

PARAMETERS

Appending /full to the URL returns results with all the data fields.

The body may optionally contain a JSON object with these parameters:

format	The report format, any of: excel (default) xml json	Optional, string
query	Optional query string using a simple but powerful query language. Example: {jobid} > 1000 AND {dtstart} > DateTime(2018, 10, 10)	Optional, string?
fields	Optional array of fields to include in the results. By default, the API returns the most commonly used fields. Use the API method ./list/fields returns all available fields. Example: [ "jobid", "reference" ]	Optional, string[]?
allfields	If set to true then the query will return all fields. The fields property is then ignored.	Optional, bool?
sort	Defines the sort order of the list. The array contains JSON objects, each with these properties: id: The column identifier. asc: Optional, default is true. True = ascending order, False = descending order Example: [ { "id": "jobid", "asc": false }, { "id": "reference" } ] Note: All lists always use a default sort order if none is specified here.	Optional, object[]?
take	Optional. Number of element to retrieve (used for pagination). If not specified then default is 100. The maximum value is 100.	Optional, int?
skip	Optional. Number of element to skip (used for pagination). If not specified then default is 0.	Optional, int?

RESULTS

The method returns a JSON object with these properties:

token

This token lets you download the report:

media/get/{token}

string

requestid

CURRENTLY NOT IMPLEMENTED

If this property is set then the file is not yet ready. You need to poll for the operation id using trm/status

string?

FORMAT DETAILS

JSON

The JSON format returned by ./list is optimized for processing by software.

For example, labels are stored with their numeric value options and not their value names. Or, some fields may be included as JSON objects instead of a print text.