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.1 | ||
| 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:///jsonapi/activities.json?company=1&version=3.1&user=user&password=user&style=modeldata&modelstructure=activitylist&client=1/F667
The list of key fields that can be used as filters include:
Job=
Jobphase=
Client/Client code=
ClientContact=
Supplier=
Suppliercontact=
Workflow=
Search=
Uuid=
Timestampfrom=
Timestampto=
Activity/Activityid=