Skip to main content
Get Criteria Information

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

StorageType, ProviderName, StorageKey, StaticColumns

GetCriteriaInformation: Get criteria information from a set of saved criteria. The result contains the restrictions in two forms: fully populated ArchiveRestrictionInfo objects, used to display details and for saving changes; and as a list suitable for an Archive control

StorageType
string
ProviderName
string
StorageKey
string
StaticColumns
string[]

Response

OK

Carrier for criteria information. It contains all the search criteria - that is, ArchiveRestrictionInfo - objects, including a column specification. In addition, it contains the same criteria expressed as an archive, with an array of ArchiveColumnInfo specifications and a set of ArchiveRow rows. The rows of the archive form a subset of the restriction array. Carrier object for CriteriaInformation. Services for the CriteriaInformation Carrier is available from the Find Agent.

Restrictions
object[]

Array of ArchiveRestrictionInfo restriction specifications (for the first restrictiongroup if there are more than one group

CriteriaArchiveColumns
object[]

Array of ColumnInfo column specifications

CriteriaArchiveRows
object[]

Array of archive list items, i.e., the service layer carrier for archive rows. These are the criteria, represented as archive rows.

RestrictionGroups
object[]

Array of restrictiongroups, including the default first group of restrictions

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.