GET metric/{itemid}/archives/{id}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
itemid `globally unique identifier` Required Metric or Project ID.	`globally unique identifier` Required Metric or Project ID.
id `globally unique identifier` Required Guid ID of the archive to be read.	`globally unique identifier` Required Guid ID of the archive to be read.

Body Parameters

None.

Response Information

Resource Description (Archive)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` ReadOnly ID of the given archive.	`globally unique identifier` ReadOnly ID of the given archive.
SiteID `globally unique identifier` ReadOnly ID of the site for the given archive.	`globally unique identifier` ReadOnly ID of the site for the given archive.
AncestorType `byte` ReadOnly Ancestor type of the given archived object.	`byte` ReadOnly Ancestor type of the given archived object.
AncestorID `globally unique identifier` ReadOnly Ancestor ID of the given archived object.	`globally unique identifier` ReadOnly Ancestor ID of the given archived object.
Name `string` ReadOnly Name of the given archived object.	`string` ReadOnly Name of the given archived object.
AncestorName `string` ReadOnly Name of the ancestor of the given archive object.	`string` ReadOnly Name of the ancestor of the given archive object.
RowType `integer` ReadOnly Row type of the given archived object.	`integer` ReadOnly Row type of the given archived object.
ArchiveDate `string` ReadOnly Date the given archive was created.	`string` ReadOnly Date the given archive was created.
ArchivedBy `globally unique identifier` ReadOnly ID of the individual that created the given archive.	`globally unique identifier` ReadOnly ID of the individual that created the given archive.
ArchiveName `string` ReadOnly Name of the given archive.	`string` ReadOnly Name of the given archive.
ArchiveComment `string` ReadOnly Comment about the given archive.	`string` ReadOnly Comment about the given archive.
ArchiveID `globally unique identifier` ReadOnly ID of the given archive.	`globally unique identifier` ReadOnly ID of the given archive.

Response Formats

application/xml, text/xml

Sample

<Archive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <AncestorID>c4f8ef28-8f19-452c-ab13-f8c6d6eabaf3</AncestorID>
  <AncestorName>sample string 2</AncestorName>
  <AncestorType>64</AncestorType>
  <ArchiveComment>sample string 5</ArchiveComment>
  <ArchiveID>437e3248-5fb7-441c-b5ff-b29d5b235ad1</ArchiveID>
  <ArchiveName>sample string 4</ArchiveName>
  <ArchivedBy>99cd7ee4-d878-472b-bac6-54443a40ce76</ArchivedBy>
  <ID>d8eacf12-c8cd-4d88-bb40-0e6d40b48187</ID>
  <Name>sample string 1</Name>
  <RowType>1</RowType>
  <SiteID>b8de19e5-f8eb-499e-860e-e957a1ddf4c8</SiteID>
</Archive>

application/json, text/json

Sample

{
  "ID": "d8eacf12-c8cd-4d88-bb40-0e6d40b48187",
  "SiteID": "b8de19e5-f8eb-499e-860e-e957a1ddf4c8",
  "AncestorType": 64,
  "AncestorID": "c4f8ef28-8f19-452c-ab13-f8c6d6eabaf3",
  "Name": "sample string 1",
  "AncestorName": "sample string 2",
  "RowType": 1,
  "ArchivedBy": "99cd7ee4-d878-472b-bac6-54443a40ce76",
  "ArchiveName": "sample string 4",
  "ArchiveComment": "sample string 5",
  "ArchiveID": "437e3248-5fb7-441c-b5ff-b29d5b235ad1"
}