Key field filters
When requesting data you can optionally pass additional parameters that will filter the data returned by a key field.
Parameter | Description | Examples |
---|---|---|
Parameters described in overview | user=user&password=user&version=3.9 | |
Company | The company context | company=1 |
Record ID | ID of a specific record to use as a filter | client=1/F667 |
Response | Returned data | A JSON string containing the data |
In this example a list of activities is returned but is filtered to only return activities for a specific client
http://<SERVER>/jsonapi/activities.json?company=1&version=3.9&user=user&password=user&style=modeldata&modelstructure=activitylist&client=1/F667
To poll for created/modified records..
http://<SERVER>/jsonapi/activities.json?company=1&version=3.9&user=user&password=user&style=modeldata&modelstructure=activitylist×tampoffsetfrom=-900
The list of key fields that can be used as filters include:
job=
jobphase=
client/client code=
clientcontact=
supplier=
suppliercontact=
workflow=
search=
uuid=
timestampfrom= (e.g. timestampfrom=1544610321)
timestampto=
timestampoffsetfrom (e.g. timestampoffsetfrom =-900 any records modified in the past 15 mins)
timestampoffsetto
Activity/Activityid=
resource=
datefrom=
dateto=