> ## 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_ G E T > Returns archive providers in OData format. Supports JSON and ATOM+XML results based on Accept headers. Supports OData query parameters: ## Filter Operators: ## ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between strings: contains, is, notBegins, notContains, isNot associate: associateIsOneOf, associateIsNotOneOf, list ids: oneOf, NotOneOf, dates: before, date, after, dateBetween, beforeToday Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period) OData returns XML or JSON carriers depending on the Accept headers. $format can also be used to control the response format via the URL.

Aggregation operators

The column names can encode grouping and summarizing. You add functions and modifiers to the column name to trigger aggregation. * GroupBy(col) * Sum(col) * Avg(col) * Percent(col) * Count(col) * CountAll(col) * DatePart(col) You add modifiers to the end of the column name to trigger aggregation. * :Header * :Footer * :HideDetail DatePart specific modifiers * :Year * :Quarter * :Month * :Day * :DayOfYear * :DayOfWeek * :Hour * :Weekno * :YearMonth * :YearWeekno * :YearQuarter 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 Some simple queries can be used to filter and simplify the result list: GET api/archives/$metadata GET api/archives/findContact GET api/archives/findContact?$top=20 GET api/archives/findContact?$select=nameDepartment,fullname GET api/archives/findContact?$filter=name begins 'foo' GET api/archives/findContact?$filter=thisAndPrevious(registered, 2, 'weeks') GET api/archives/findContact?$select=nameDepartment,fullname&$filter=name begins 'foo' ## OpenAPI ````yaml /openapi/rest/openapi-v3-Archive.json get /api/v1/Archive/{archiveProviderName} openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - Archive 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/Archive/{archiveProviderName}: get: tags: - Archive summary: Get Archive_ G E T description: "Returns archive providers in OData format.\n\nSupports JSON and ATOM+XML results based on Accept headers. Supports OData query parameters:\r\n
  • $select=col1,col2,abc/col3
  • $filter=col1 eq 'foo' and startswith(col2, 'baz')
  • $orderby=col1,abc/col3
  • $top=1000
  • $options=GrandTotal=true
  • $context=foo
  • $format=json
\r\n## Filter Operators: ##\r\n\r\nints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between\r\n\r\nstrings: contains, is, notBegins, notContains, isNot\r\n\r\nassociate: associateIsOneOf, associateIsNotOneOf, \r\n\r\nlist ids: oneOf, NotOneOf, \r\n\r\ndates: before, date, after, dateBetween, beforeToday\r\n\r\nUnary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear\r\n\r\nFuncs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)\r\n\r\n\r\nOData returns XML or JSON carriers depending on the Accept headers. $format can also be used to \r\ncontrol the response format via the URL. \r\n\r\n

Aggregation operators

\r\n\r\nThe column names can encode grouping and summarizing.\r\nYou add functions and modifiers to the column name to trigger aggregation.\r\n\r\n* GroupBy(col)\r\n* Sum(col)\r\n* Avg(col)\r\n* Percent(col)\r\n* Count(col)\r\n* CountAll(col)\r\n* DatePart(col)\r\n\r\n\r\n\r\nYou add modifiers to the end of the column name to trigger aggregation.\r\n\r\n* :Header\r\n* :Footer\r\n* :HideDetail\r\n\r\n\r\nDatePart specific modifiers\r\n* :Year\r\n* :Quarter\r\n* :Month\r\n* :Day\r\n* :DayOfYear\r\n* :DayOfWeek\r\n* :Hour\r\n* :Weekno\r\n* :YearMonth\r\n* :YearWeekno\r\n* :YearQuarter\r\n\r\n\r\nExample: group last names together, and inject a header row for each group.\r\n\r\nGroupBy(lastName):Header\r\n\r\nExample: count instances of middle names, and hide the individual rows, \r\nreport just the totals for each group using a footer. Note how the modifiers stack.\r\n\r\nCount(middleName):HideDetail:Footer\r\n\r\nExample: the aggregator functions can nest, so you can say\r\n\r\nGroupBy(DatePart(personUpdatedDate):YearMonth):Header\r\n\r\nSome simple queries can be used to filter and simplify the result list:\r\n\r\nGET api/archives/$metadata\r\nGET api/archives/findContact\r\nGET api/archives/findContact?$top=20\r\nGET api/archives/findContact?$select=nameDepartment,fullname\r\nGET api/archives/findContact?$filter=name begins 'foo'\r\nGET api/archives/findContact?$filter=thisAndPrevious(registered, 2, 'weeks')\r\nGET api/archives/findContact?$select=nameDepartment,fullname&$filter=name begins 'foo'\r\n" operationId: v1Archive_GetArchive_GET parameters: - name: archiveProviderName in: path description: >- Archive Provider name: FindContact, Person, Product, etc. Call with blank name to get a list of names. required: true schema: type: string - name: $select in: query description: >- Comma separated list of column names to return. "nameDepartment,fullname,category". Can also use aggregation functions and modifiers: "Count(category):Footer" required: false schema: type: string - name: $filter in: query description: >- Expression to restrict the results. e.g.: "name begins 'foo' and category gt 1". required: false schema: type: string - name: $orderBy in: query description: >- Comma separated list of column names to sort by, with optional direction. "name asc,fullname,category desc" required: false schema: type: string - name: $entities in: query description: >- Comma separated list of entity names to use. Default = "", which means all entities. "contact, person" required: false schema: type: string - name: $top in: query description: Number of rows to return in results. required: false schema: type: integer format: int32 - name: $skip in: query description: Number of rows to skip before returning results. required: false schema: type: integer format: int32 - name: $mode in: query description: >- FULL (with raw values and hints for each value) or SLIM (just the display values) required: false schema: type: string enum: - Slim - Wide - Full - name: $options in: query description: 'Provider specific options. e.g: "GrandTotal=true"' required: false schema: type: string - name: $context in: query description: Provider specific context parameter. Usually blank. required: false schema: type: string - name: $format in: query description: >- Set XML or JSON output format, override the format determined from Accept header. required: false schema: type: string - name: $metadata in: query description: >- Default: "ALL" to return description of all columns. Overrides $select and other parameters. required: false schema: type: string - name: $inlineCount in: query description: Determine how/if row count is returned in the result required: false schema: type: string enum: - 'False' - Estimate - 'True' - AllPages - name: $jsonSafe in: query description: >- Make output names into JSON safe property names. Replace all unsafe characters with _ underscore. required: false schema: type: boolean - name: $output in: query description: >- Return Logical or Display values in SLIM mode. Logical returns true/false for booleans, Display returns icon hints. Dates are always returned as ISO strings. required: false schema: type: string enum: - Logical - Display - 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 responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse text/json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/xml: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse text/xml: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.Services.WebApi.OData.ODataSlimResponse security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.Services.WebApi.OData.ODataSlimResponse: description: Easy to use archive results - just a flat list of values. type: object properties: odata.metadata: type: string odata.nextLink: type: string value: type: array items: type: object additionalProperties: type: object ```` ## Related topics - [Get Archive](/en/api/reference/restful/rest/archive/get-archive.md) - [Get Archive Configuration](/en/api/reference/restful/agent/archive_agent/get-archive-configuration.md) - [Archive agent](/en/automation/crmscript/netserver/crmscript-archiveagent.md) - [Get Archive Metadata](/en/api/reference/restful/rest/archive/get-archive-metadata.md) - [Get Archive List](/en/api/reference/restful/agent/archive_agent/get-archive-list.md) - [Get Archive List2](/en/api/reference/restful/agent/archive_agent/get-archive-list2.md)