Skip to main content
Get Selection For Find

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

EntityName, TypicalSearchId

GetSelectionForFind: Obtain a selection for the given entity, for the current user, of type WorkingSetForFind. Optionally populate criteria from the TypicalSearches system

EntityName
string
TypicalSearchId
integer<int32>

Response

OK

Provider name and selection id for a Find temporary selection Carrier object for SelectionForFind. Services for the SelectionForFind Carrier is available from the Selection Agent.

ProviderName
string

The name of the Archive Provider to use when working with this selection; this is the main entity provider, never Shadow, Combined or anything else fancy

SelectionId
integer<int32>

Primary key

CanSaveAsSelection
boolean

Most Find entities support saving the search as a Dynamic Selection: this bool indicates if that is the case

MainHeading
string

'Sale', intended for the main headings in the Find front page; this string will contain resource references

FilterScreenHeading
string

'Find sale', or whatever is appropriate for the Find filter page; this string will contain resource references

SelectionEntityHeading
string

'Companies', or whatever else is appropriate - the plural form of the entity name, intended for the Selection.Details tab before it is saved (!!); this string will contain resource references

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.