Skip to main content

List of archives

What archives are available from the API?

OData

Returns a list of archive names as an OData result:

Archive Agent

Returns a list of archive provider names as an array:

List of columns available in an archive

OData

Add the $metadata suffix to the archive name, and you get a description of the archive. If we do not specify a language with Accept-Language or SO-Language, we get untranslated resources back instead of the translated strings.
Returns a list of columns in the given archive as an OData result:

Archive Agent

Returns a list of columns available from the given archive provider as an array:
  • CanRestrictBy tells us whether we can use the column as a filter.
  • RestrictionType tells us what operators we can use with this column. See @odata_filters
  • RestrictionListName is the MDO list name to use if the restriction type is a list.
  • IconHint is an indication of what type of column is used. Can be used for grouping.
The GetAll and GetNone are special restrictions to be explicit about fetching all or none.