Common concepts

ParamQuery

The query parameter search syntax used widely throughout Programs API. Consists of two optional parts: include and exclude, the query is expressed as include!exclude.

include and exclude have the same syntax: a comma separated list of conditions, i.e. C1,C2,C3. Matches if any of the conditions are true.

Each condition consists of one or more values separated by a semicolon, i.e. V1;V2. Matches if an object has all the values.

Examples:

A1,A2,A3 - Matches objects that have one of values A1 or A2 or A3, i.e. A1 || A2 || A3.

A1;A2;A3 - Matches only objects that have the values A1 and A2 and A3, i.e. A1 & A2 & A3.

A1,A2;A3,A4 - Matches objects that have either the value A1 or A2 and either the value A3 or A4, i.e. (A1 || A2) & (A3 || A4).

A1;A2,A3;A4 - Matches objects that have either the values A1 and A2 or the values A3 and A4, i.e. (A1 & A2) || (A3 & A4).

A1!A2 - Matches objects that have the value A1 and not the value A2, i.e. A1 & !A2.

A1,A2!A3,A4 - Matches objects that have one of the values A1 or A2 and neither of the values A3 or A4, i.e. (A1 || A2) & !(A3 || A4).