_URI Query Parameters

Identifies the unique customer id assigned by ServicePower. This value will never change.

 This property is being deprecated in favor of JSON Web Token support via the x-access-token HTTP header.

Identifies the unique customer code associated with the Customer and assigned by ServicePower. The Customer should keep this code confidential. If required, such as an IT employee being released from the Customer's organization, a new customer code can be requested.

 This property is being deprecated in favor of JSON Web Token support via the x-access-token HTTP header.

The filter parameter syntax is:

filter=field:value,filter:field:value,...

• field = Identified the field name of the object to filter against
• value = Identifies the value to be matched against the field

The filter parameter is used to quickly reduce the result set based on the field values provided. Although the filter is case-insensitive it does preform an exact match.

Example:

filter=WorkCenter:EastCoast

This will return all objects where the WorkCenter field has a value of EastCoast

Identifies the maximum number of objects to be returned.

The q parameter syntax is:

q=<search term>::in:field-1,field-2

The q (query) parameter supports partial term matches across multiple fields. For example, a search_term of Joh will match John, John's, Johansson, Johansen.

The query parameter currently supports one search term, although it can be combined with the filter parameter.

Identifies the field name that should be used for sorting.

The sort syntax is:

sort=[-]field-1,[-]field-2

• field-1 = The field name to sort against
• [ - ] = Optional value that identifies the field is to be sorted in descending order