Skip to main content

Enums

Version: 1.0.0

EnvironmentModes

This enum defines the different modes a tenant can operate in.

IDValuesDescriptions
0DevelopmentThe tenant is in development mode, used for development and testing
1TestingThe tenant is in testing mode, used for quality assurance
2StagingThe tenant is in staging mode, used for pre-production testing
3ProductionThe tenant is in production mode, used for live operations

FieldFilterOperator

The operator to use for filtering fields.

IDValuesDescriptions
0EqualsCompares the specified field to the specified value.
1NotEqualsCompares the specified field to the specified value and returns true if the values are not equal.
2LessThanCompares the specified field to the specified value and returns true if the field value is less than the specified value.
3LessEqualThanCompares the specified field to the specified value and returns true if the field value is less than or equal to the specified value.
4GreaterThanCompares the specified field to the specified value and returns true if the field value is greater than the specified value.
5GreaterEqualThanCompares the specified field to the specified value and returns true if the field value is greater than or equal to the specified value.
6InCompares a field to be equal any value in the specified array.
7NotInCompares a field to be not equal any value in the specified array.
8LikeCompares a field to the specified value using a pattern matching comparison. Use * as a wildcard character.
9MatchRegExMatches a field containing a value that matches the specified regular expression.
10AnyEqCompares an array field with at least one element that matches the specified value.
11AnyLikeCompares an array field with at least one element that matches the specified value using a pattern matching comparison. Use * as a wildcard character.
12MatchMatches 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.

IDValuesDescriptions
0OffThe maintenance mode is off, the tenant is fully operational
1UserAppsThe user apps are in maintenance mode, the tenant is operational but user apps are not available
2FullSystemThe full system is in maintenance mode, the tenant is not operational

QueryTypes

The type of query

IDValuesDescriptions
0FlatA flat query
1TreeA tree query that returns results from a tree

SortOrders

The sort order of a field.

IDValuesDescriptions
0DefaultDefault sorting based on data source type
1AscendingAscending order
2DescendingDescending order