Comparison Expressions
Comparison expressions let you compare resource parameters with specific values. Comparison expressions have the following format:
<parameter><operator><value> |
where:
- <parameter> is a name of the query parameter that you are able to use for filtering.
To learn what query parameters are available for a specific resource, see the Query Parameters section in the GET HTTP method description of the resource. For example, GET /backupServers/{ID}.
- <operator> is an operator that compares the parameter and value. For details, see Comparison Operators.
- <value> is a parameter value.
Comparison expression may contain the following operators.
Comparison Operator | Query Syntax Character | Description |
|---|---|---|
Greater | > | The resource parameter must be greater than the specified value. |
Less | < | The resource parameter must be less than the specified value. |
Equal | == | The resource parameter must be equal to the specified value. |
Does not equal | != | The resource parameter must not be equal to the specified value. |
Greater or equal | >= | The resource parameter must be greater than or equal to the specified value. |
Less or equal | <= | The resource parameter must be less than or equal to the specified value. |
Note |
If a resource parameter has an array of possible values, the values are compared by their index. For example, the Result parameter of a backup job session has the following possible values listed in the acceding order:
In this example, the Failed value is greater than the Success value. |
Example
To get a backup job with the Exchange Backup name, use the following query.
Request: GET https://localhost:9398/api/query?type=job&filter=name=="Exchange Backup"
Response: 200 OK
Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |