Description

An option that constrains or filters to narrow the selection of a resource or a collection of resources.

 

Syntax

 

Remarks

When applied to content, the <query> may specify constraints such as a search pattern or another selection criterion.

In addition to directly constraining the content or properties, the <query> may be used to constrain or filter factors that are external to the URI but are used by the method. For example, the <query> may constrain the effect of the method to a specific authenticated caller or callers. A <query> may be thought of as extra “parameters” to the method being invoked using the URI.

The query component contains non-hierarchical data that, along with data in the path component, serves to identify a resource within the scope of the URI's scheme and naming authority (if any).  The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI.

The characters slash ("/") and question mark ("?") may represent data within the query component.

For an example of a query syntax, see the Parameters section on the following API reference pages, as listed in the Supported Methods section, below.

 

Supported Methods

The following table describes the methods that use queries in CaseMap Server.

 

Examples

Request Example

The following request retrieves a query result from case-6, as described in the example section of GET get-case-facts.