Skip to main content
Get Dynamic Selection Criteria

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

SelectionId

GetDynamicSelectionCriteria: Get the criteria for this dynamic selection.

SelectionId
integer<int32>

Response

OK

Name
string

The programmatic column name, including any required prefixes

Operator
string

The operator, such as =, etc

Values
string[]

Value(s) to test against

DisplayValues
string[]

Display representation of value(s) - list ID's are decoded to display texts, other values are represented in a format suitable for decoding and display through the {SuperOffice.CRM.Globalization.CultureDataFormatter}.

ColumnInfo
object

This class carries information about the definition and properties of an archive display column. It is used by the archive MDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type (and other properties) each column has. The class is serializable and used on both the application and Web server sides.

IsActive
boolean

Is this restriction active? Inactive restrictions will not influence the generated query

SubRestrictions
array

Optional collection of sub criteria, usually null but set for Saint counter fields

InterParenthesis
integer<int32>

Get or set the parenthesis (if any) associated with this restriction. Positive values indicate a number of opening parentheses (deepening nesting level), while negative numbers indicate closing parentheses. Zero means no change in nesting level (no parentheses).

InterOperator
enum<string>

Get or set the inter-restriction operator that describes how this restriction is related to the next one in an array. Default for new ArchiveRestrictionInfo objects is And

Available options:
None,
And,
Or
UniqueHash
integer<int32>