Skip to main content
Get Archive Configuration V2

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

GuiName, ProviderName, Context, OwnerKeys

GetArchiveConfigurationV2: Get the configuration for one archive. The configuration is keyed by a combination of archive provider name (plus optional context), gui name, and optional table binding. The archive provider name must match an archive provider plugin; the gui name is an arbitrary string used to distinguish multiple occurrences of the same underlying provider in a gui.

GuiName
string
ProviderName
string
Context
string
OwnerKeys
string

Response

OK

This service is used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.Note that desired columns can be set through the selectable mdo list called archiveColumns:<perovider name>, and entities can be set through the selectable mdo list archiveEntities:<provider name>. You can also use the SetChosenEntities and SetChosenColumns method of this service. The selectable mdo list implementation is suitable for data binding using mdo list controls. Carrier object for ArchiveConfiguration. Services for the ArchiveConfiguration Carrier is available from the Archive Agent.

ArchiveColumnInfo
object[]
ArchiveEntityInfo
object[]
ArchiveOrderByInfo
object[]
OwnerKeys
string

The actual ownership information for the configuration that was retrieved

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.