Custom query options

The following is specific to our WorkZone Service OData provider.

Query option	Understood by	Description	Example
contains	GET: Files, Records, Documents, Contacts, Addresses, RegisterTexts	The value of the contains parameter maps to a free text search criteria in GET operations.	OData.svc/Files?contains=test Matches all Files where the free text contains the word test.
domainRestriction	GET: *	The value of the domainRestriction is used to filter the query according to the domain specification with the given name for the given entity type. The domainRestriction option can be combined with a $filter option to further filter the results. The domainRestriction option is used by the PredefinedFilter type to filter results based on the standard definition of list in WorkZone. The domainRestriction option can also be used to request only entities that are considered active.	OData.svc/Files?domainRestriction=my_open_cases Matches all Files where the current user is the Officer and the File is open. OData.svc/Contacts?domainRestriction=active Will filter the Contacts feed to only include the Contacts that are considered valid/active.
searchRestriction	GET: *	The value of the searchRestriction must be a number with type string that identifies a user stored search in WorkZone. The searchRestriction option can be combined with a $filter option to further filter the results. The searchRestriction is used by the Search type. The Search type represents a stored search in WorkZone. The searchRestriction is used when executing such a stored Search.	OData.svc/Files?searchRestriction=41 Finds all Files matching the stored search criteria identified by the Search ID 41.

Query option

Understood by

Description

Example

contains

GET: Files, Records, Documents, Contacts, Addresses, RegisterTexts

The value of the contains parameter maps to a free text search criteria in GET operations.

OData.svc/Files?contains=test

Matches all Files where the free text contains the word test.

domainRestriction

GET: *

The value of the domainRestriction is used to filter the query according to the domain specification with the given name for the given entity type.

The domainRestriction option can be combined with a $filter option to further filter the results.

The domainRestriction option is used by the PredefinedFilter type to filter results based on the standard definition of list in WorkZone.

The domainRestriction option can also be used to request only entities that are considered active.

OData.svc/Files?domainRestriction=my_open_cases

Matches all Files where the current user is the Officer and the File is open.

OData.svc/Contacts?domainRestriction=active

Will filter the Contacts feed to only include the Contacts that are considered valid/active.

searchRestriction

GET: *

The value of the searchRestriction must be a number with type string that identifies a user stored search in WorkZone.

The searchRestriction option can be combined with a $filter option to further filter the results.

The searchRestriction is used by the Search type.

The Search type represents a stored search in WorkZone.

The searchRestriction is used when executing such a stored Search.

OData.svc/Files?searchRestriction=41

Finds all Files matching the stored search criteria identified by the Search ID 41.