Content and filters

Metadata, filtering and schemas

Each API resource's documentation includes JSON schemas and sample files for validating request bodies in client side.

Schemas do not include all possible properties, only the essentially required and common ones.

To see all available fields, filter parameters, list values and data formats of fieldss for a specific customer instance, make a GET request to both a single resource's metadata end point (/timereports/123/meta) and a collection's metadata enpoint (/timereports/meta).

Filtering can be done using any of the columns as filters, even if they are not documented as filters in the /meta -endpoints.

Metadata -enpoints return the format of the fields handled by the endpoint. Note that format effortunit means the data is returned always in minutes (regardless of the name of the field). To get hours, divide the number with 60.

If you still find that data is returned in incorrect format from some endpoint it's usually because some individual text field contains numbers and is missing datatype information in our system. Please contact our support so we can fix it.

Selecting necessary fields in GET

You may remove non-required fields from results of those GET-commands which correspond with tables for PlanMill modules. This functionality is off by default, contact Planmill maintenance to switch it on.

To select necessary fields, login as API user, select a PlanMill module (such as Accounts), choose "Table settings" in the right top of the table and remove a column, corresponding with the field, from selected column. Removing a column which corresponds to a obligatory field has no effect, and selecting a column that has no corresponding field in API has no effect. Currently it is not documented which fields are obligatory.