> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Archive Configuration V2 > 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. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-ArchiveAgent.json post /api/v1/Agents/Archive/GetArchiveConfigurationV2 openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - ArchiveAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Archive/GetArchiveConfigurationV2: post: tags: - Archive_Agent summary: Get Archive Configuration V2 description: "Get the configuration for one archive.\n\nThe 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.\r\nNsApiSlow threshold: 5000 ms." operationId: v1ArchiveAgent_GetArchiveConfigurationV2 parameters: - name: $select in: query description: >- 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. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request description: GuiName, ProviderName, Context, OwnerKeys required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ArchiveConfiguration security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetArchiveConfigurationV2Request: description: >- 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. type: object properties: GuiName: type: string ProviderName: type: string Context: type: string OwnerKeys: type: string SuperOffice.CRM.Services.ArchiveConfiguration: description: "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.\r\n\r\nCarrier object for ArchiveConfiguration.\r\nServices for the ArchiveConfiguration Carrier is available from the Archive Agent." type: object properties: ArchiveColumnInfo: description: '' type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo ArchiveEntityInfo: description: '' type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem ArchiveOrderByInfo: description: '' type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveOrderByInfo OwnerKeys: description: >- The actual ownership information for the configuration that was retrieved type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo: description: "This class carries information about the definition and properties of an archive display column. It is used by the archive\r\nMDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type\r\n(and other properties) each column has. The class is serializable and used on both the application\r\nand Web server sides." type: object properties: DisplayName: description: The column name to show, can be a resource identifier string type: string DisplayTooltip: description: >- The column tooltip, used in the column list and in the column headings type: string DisplayType: description: "Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted).\r\nThis name can contain resource tags." type: string CanOrderBy: description: Can this column be used for sorting? type: boolean Name: description: "Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider,\r\nsetting restrictions or order by criteria" type: string CanRestrictBy: description: Can this column be used as a restriction type: boolean RestrictionType: description: >- The data type of the restriction; use this to retrieve the legal operators for the restriction type: string RestrictionListName: description: >- If the restriction data type is 'list', this property contains the name of the SoList so that choices can be shown type: string IsVisible: description: Is this column visible to the user in configuration dialogs etc type: boolean ExtraInfo: description: >- Example: "navigator" -> Should this column be mapped to a hyperlinked navigator text type? type: string Width: description: "The width specification, if the column info has been extended with GUI-based information.\r\nIt is either \"n%\" or \"nc\", where n is an integer. Percent-formatted fields grow and shrink; number-of-characters\r\nformatted fields have constant width when the whole archive width changes." type: string IconHint: description: "Icon hint corresponding to the display name; this icon hint is used in the configuration dialog\r\nand other places where we 'talk about' the columns of the archive. The actual heading\r\nof the archive may also contain icons in lieu of textual names, the icon hint for that\r\nis specified in {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.HeadingIconHint} and is a different one." type: string HeadingIconHint: description: "Icon hint for the archive heading only. If this is a nonempty string, the archive header\r\nshould use this icon and ignore the {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.DisplayName}. Otherwise, the DisplayName\r\nshould be used as the heading." type: string SuperOffice.CRM.Services.SelectableMDOListItem: description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer IconHint: description: The Icon hint of the ListItem. Custom field. type: string Selected: description: True if the ListItem is selected type: boolean LastChanged: format: date-time description: Time of last change. type: string ChildItems: description: The child items of the SelectableMDOListItem type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string Hidden: description: True if the ListItem is hidden type: boolean FullName: description: The name of the ListItem in its context type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.ArchiveLists.ArchiveOrderByInfo: description: >- This class carries information about an ordering criterion for an archive type: object properties: Name: description: >- Programmatic name of the column to order by, semantically the same as the ArchiveColumnInfo {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.Name}. type: string Direction: description: Direction to order enum: - ASC - DESC type: string SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Archive GetArchiveConfigurationV2Request](/en/api/reference/webapi/SuperOffice.WebApi.Data.Archive_GetArchiveConfigurationV2Request.md) - [NSArchiveAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveAgent.md) - [SuperOffice.WebApi.Agents.ArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ArchiveAgent.md) - [SuperOffice.WebApi.Agents.IArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IArchiveAgent.md) - [Get Archive Configuration](/en/api/reference/restful/agent/archive_agent/get-archive-configuration.md) - [Get Archive Configuration With Context](/en/api/reference/restful/agent/archive_agent/get-archive-configuration-with-context.md)