Enums
EnvironmentModes
This enum defines the different modes a tenant can operate in.
| ID | Values | Descriptions |
|---|---|---|
| 0 | Development | The tenant is in development mode, used for development and testing |
| 1 | Testing | The tenant is in testing mode, used for quality assurance |
| 2 | Staging | The tenant is in staging mode, used for pre-production testing |
| 3 | Production | The tenant is in production mode, used for live operations |
FieldFilterOperator
The operator to use for filtering fields.
| ID | Values | Descriptions |
|---|---|---|
| 0 | Equals | Compares the specified field to the specified value. |
| 1 | NotEquals | Compares the specified field to the specified value and returns true if the values are not equal. |
| 2 | LessThan | Compares the specified field to the specified value and returns true if the field value is less than the specified value. |
| 3 | LessEqualThan | Compares the specified field to the specified value and returns true if the field value is less than or equal to the specified value. |
| 4 | GreaterThan | Compares the specified field to the specified value and returns true if the field value is greater than the specified value. |
| 5 | GreaterEqualThan | Compares the specified field to the specified value and returns true if the field value is greater than or equal to the specified value. |
| 6 | In | Compares a field to be equal any value in the specified array. |
| 7 | NotIn | Compares a field to be not equal any value in the specified array. |
| 8 | Like | Compares a field to the specified value using a pattern matching comparison. Use * as a wildcard character. |
| 9 | MatchRegEx | Matches a field containing a value that matches the specified regular expression. |
| 10 | AnyEq | Compares an array field with at least one element that matches the specified value. |
| 11 | AnyLike | Compares an array field with at least one element that matches the specified value using a pattern matching comparison. Use * as a wildcard character. |
| 12 | Match | Matches an array field with at least one element that matches all the specified query criteria. |
MaintenanceLevels
This enum defines the maintenance level of a tenant.
| ID | Values | Descriptions |
|---|---|---|
| 0 | Off | The maintenance mode is off, the tenant is fully operational |
| 1 | UserApps | The user apps are in maintenance mode, the tenant is operational but user apps are not available |
| 2 | FullSystem | The full system is in maintenance mode, the tenant is not operational |
QueryTypes
The type of query
| ID | Values | Descriptions |
|---|---|---|
| 0 | Flat | A flat query |
| 1 | Tree | A tree query that returns results from a tree |
SortOrders
The sort order of a field.
| ID | Values | Descriptions |
|---|---|---|
| 0 | Default | Default sorting based on data source type |
| 1 | Ascending | Ascending order |
| 2 | Descending | Descending order |