Get Default Desired Columns
Calculate the default desired columns, i.
e., the result columns for a given search. The search is defined by a storage type, provider name and storage key, which are used to fetch the corresponding restrictions from the database (in the same way as Find does). If you want to specify the restriction directly, use the GetDefaultDesiredColumnsFromRestrictions method instead. This is the algorithm that is used by the Find service method. NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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
GetDefaultDesiredColumns: Calculate the default desired columns, i.e., the result columns for a given search. The search is defined by a storage type, provider name and storage key, which are used to fetch the corresponding restrictions from the database (in the same way as Find does). If you want to specify the restriction directly, use the GetDefaultDesiredColumnsFromRestrictions method instead. This is the algorithm that is used by the Find service method.
Response
OK
The column name to show, can be a resource identifier string
The column tooltip, used in the column list and in the column headings
Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted). This name can contain resource tags.
Can this column be used for sorting?
Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider, setting restrictions or order by criteria
Can this column be used as a restriction
The data type of the restriction; use this to retrieve the legal operators for the restriction
If the restriction data type is 'list', this property contains the name of the SoList so that choices can be shown
Is this column visible to the user in configuration dialogs etc
Example: "navigator" -> Should this column be mapped to a hyperlinked navigator text type?
The width specification, if the column info has been extended with GUI-based information. It is either "n%" or "nc", where n is an integer. Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.
Icon hint corresponding to the display name; this icon hint is used in the configuration dialog and other places where we 'talk about' the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.HeadingIconHint} and is a different one.
Icon hint for the archive heading only. If this is a nonempty string, the archive header should use this icon and ignore the {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.DisplayName}. Otherwise, the DisplayName should be used as the heading.
Related topics
Get Default Desired Columns From RestrictionsGet Default Desired Columns From Restrictions2Find From Restrictions Columns Order ByNSFindAgentFind From Restrictions ColumnsFind From Restrictions Columns Order By2