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>932c8caf-4435-46ec-8b84-baadc84519b1</AncestorID>
  <AncestorName>sample string 2</AncestorName>
  <AncestorType>64</AncestorType>
  <ArchiveComment>sample string 5</ArchiveComment>
  <ArchiveID>065495c3-523f-47da-bed0-466bc0cd58e7</ArchiveID>
  <ArchiveName>sample string 4</ArchiveName>
  <ArchivedBy>29460355-1739-48f7-8e33-281f16861a02</ArchivedBy>
  <ID>e51eb839-37bc-4cf6-a669-cc1562acdfd6</ID>
  <Name>sample string 1</Name>
  <RowType>1</RowType>
  <SiteID>0cfe1ba5-014f-469d-832d-fc7fa0124d07</SiteID>
</Archive>

application/json, text/json

Sample

{
  "ID": "e51eb839-37bc-4cf6-a669-cc1562acdfd6",
  "SiteID": "0cfe1ba5-014f-469d-832d-fc7fa0124d07",
  "AncestorType": 64,
  "AncestorID": "932c8caf-4435-46ec-8b84-baadc84519b1",
  "Name": "sample string 1",
  "AncestorName": "sample string 2",
  "RowType": 1,
  "ArchivedBy": "29460355-1739-48f7-8e33-281f16861a02",
  "ArchiveName": "sample string 4",
  "ArchiveComment": "sample string 5",
  "ArchiveID": "065495c3-523f-47da-bed0-466bc0cd58e7"
}