> ## 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 Available Entities > Return list of all entities supported by an archive provider. See also GetArchiveConfiguration. NsApiSlow threshold: 5000 ms. Archive Restriction strings are OData or SQL-ish. They are parsed and converted into ArchiveRestrictions. For example: "name begins 'Super'" "category = 3" "category in (2,3,4)" "xstop set" "registered after '2014.3.4'" "registered dateBetween ('2014.11.29', '2014.12.25')" Unary operators: "updatedDate lastWeek", "assocId currentAssociate"

Brackets and or

AND and OR can be used to combine terms. AND has a higher priority than OR "business = 2 AND name contains 'super'" Brackets can be used for grouping. "(business = 2 or category = 3) and name contains 'super'"

Aggregation operators

The column names can encode grouping and summarizing. You add functions and modifiers to the column name to trigger aggregation. Example: group last names together, and inject a header row for each group. GroupBy(lastName):Header Example: count instances of middle names, and hide the individual rows, report just the totals for each group using a footer. Note how the modifiers stack. Count(middleName):HideDetail:Footer Example: the aggregator functions can nest, so you can say GroupBy(DatePart(personUpdatedDate):YearMonth):Header

Strings

Use the begins or contains operators to do string searches. You can also use the normal = operator to do string exact match checks. Use backslash to escape single quotes in strings (note that backslash needs to be doubled because c# also uses backslash escapes): "department contains 'Bob\\'s'" ## OpenAPI ````yaml /openapi/agent/openapi-v3-ArchiveAgent.json post /api/v1/Agents/Archive/GetAvailableEntities 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/GetAvailableEntities: post: tags: - Archive_Agent summary: Get Available Entities description: "Return list of all entities supported by an archive provider.\n\nSee also GetArchiveConfiguration.\r\nNsApiSlow threshold: 5000 ms. \r\n\r\n Archive Restriction strings are OData or SQL-ish.\r\n They are parsed and converted into ArchiveRestrictions.\r\n \r\n\r\n For example:\r\n \r\n \"name begins 'Super'\"\r\n \"category = 3\"\r\n \"category in (2,3,4)\"\r\n \"xstop set\"\r\n \"registered after '2014.3.4'\"\r\n \"registered dateBetween ('2014.11.29', '2014.12.25')\"\r\n \r\n Unary operators:\r\n \"updatedDate lastWeek\", \"assocId currentAssociate\"

Brackets and or

\r\nAND and OR can be used to combine terms. AND has a higher priority than OR\r\n\"business = 2 AND name contains 'super'\"\r\nBrackets can be used for grouping.\r\n\"(business = 2 or category = 3) and name contains 'super'\"

Aggregation operators

\r\n\r\n The column names can encode grouping and summarizing.\r\n You add functions and modifiers to the column name to trigger aggregation.\r\n \r\n\r\n Example: group last names together, and inject a header row for each group.\r\n \r\n GroupBy(lastName):Header\r\n \r\n Example: count instances of middle names, and hide the individual rows, \r\n report just the totals for each group using a footer. Note how the modifiers stack.\r\n \r\n Count(middleName):HideDetail:Footer\r\n \r\n Example: the aggregator functions can nest, so you can say\r\n \r\n GroupBy(DatePart(personUpdatedDate):YearMonth):Header\r\n

Strings

\r\n\r\n Use the begins or contains operators to do string searches.\r\n You can also use the normal = operator to do string exact match checks.\r\n \r\n\r\n\r\n Use backslash to escape single quotes in strings\r\n (note that backslash needs to be doubled because c# also uses backslash escapes):\r\n \r\n\"department contains 'Bob\\\\'s'\"" operationId: v1ArchiveAgent_GetAvailableEntities 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.GetAvailableEntitiesRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest description: ProviderName, Context required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' text/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' application/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' text/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' application/merge-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetAvailableEntitiesRequest: description: >- GetAvailableEntities: Return list of all entities supported by an archive provider. See also GetArchiveConfiguration. type: object properties: ProviderName: type: string Context: type: string SuperOffice.CRM.Services.MDOListItem: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem 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 ChildItems: description: The child items of the MDOListItem type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer 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 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.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 GetAvailableEntitiesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Archive_GetAvailableEntitiesRequest.md) - [How to perform an archive provider query](/en/api/archive-providers/how-to-query.md) - [IArchiveProvider](/en/api/plugins/quote-connectors/api/iarchiveprovider.md) - [Get Available Fields](/en/api/reference/restful/agent/bulkupdate_agent/get-available-fields.md) - [Get Role Entity](/en/api/reference/restful/agent/user_agent/get-role-entity.md)