General information

Date format

The format of date values in requests and responses is YYYY-MM-DDTHH:II:SSZ, where Z ist the timezone offset (difference between current timezone and UTC)

Examples for UTC date 2014-01-01T00:00:00:

Timezone Europe/Berlin (CEST): 2014-01-01T01:00:00+01:00
Timezone America/Los_Angeles (PST): 2013-12-31T16:00:00-08:00
Timezone Pacific/Pago_Pago (SST): 2013-12-31T13:00:00-11:00
Timezone Asia/Singapore (SGT): 2014-01-01T08:00:00+08:00

Filters

Some GET resources support a filter for response items. The search values are given in the parameter where (as an associative array).
The values have to be provided in the form where[fieldname][operator]=value.
Not all operators are always supported.
Examples:

Operator	Sample	Description
=	where[name][eq]=test	Name is equal "test"
>	where[sum][gt]=100	Sum is greater than 100
<	where[sum][lt]=100	Sum is less than 100
>=	where[sum][gte]=100	Sum is greater than or equal 100
<=	where[sum][lte]=100	Sum is less than or equal 100
IN	where[id][in]=1,2,3,4	Id equals 1, 2, 3 or 4
LIKE	where[name][like]=test	Name contains test (e.g. Peter Tester)
<>	where[name][neq]=Peter	Name is not equal "peter"

For index fields with lists of allowed values, it is possible to search by entry name in the user language. The syntax is: where[index field name][operator]=label{entry name}. For example, there is an index field documentType with the name/value pairs Invoice/1, Documentation/2 and Note/3. To search for documents with type "Invoice", use where[documentType][eq]=label{Invoice}

Group / Distinct

To group the results of a resource, the parameter distinct=1 can be added to the query string.

Example: /jobrouter/api/rest/archiveindices/testarchive/indexfield1?distinct=1

Please note: The parameter is not available for all resources. See the specific resource to check whether it is available.

Options

This request type returns the request methods supported by the resource.

Example response:

HTTP Status Code: 200 OK
Content-Type: application/json
{{{options_response}}}

{{#each resources}}

{{{description}}}

{{#if deprecated}}

{{{deprecated}}}

{{/if}} {{#each routes}}

{{method}} {{route}}

{{{route_description}}} {{#if deprecated}}

{{deprecated}}

{{/if}} {{#if parameters}}

Parameters:

{{name}}: {{parameter_description}}

{{/if}} {{#if conditions}}

Parameter constraints:

{{value}}: {{pattern}}

{{/if}} {{#if request}}

Request:

Content-Type: {{request.contentType}}
{{{request.content}}}

{{/if}} {{#if response}}

Response:

HTTP Status Code: {{response.statusCode}}
Content-Type: {{response.contentType}}
{{{response.content}}}

{{/if}} {{#if exceptions}}

Exceptions:

HTTP Status Code: {{statusCode}}
Content-Type: {{contentType}}
{{{content}}}

{{/if}}

{{/each}}

{{/each}}