GET archives/{id}

Request Information

URI Parameters

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

Name	Description
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>9f42c192-d7dc-4ab7-bae5-82343ed65d0a</AncestorID>
  <AncestorName>sample string 2</AncestorName>
  <AncestorType>64</AncestorType>
  <ArchiveComment>sample string 5</ArchiveComment>
  <ArchiveID>d52c1b70-8fe9-4304-85aa-102a397b2dd3</ArchiveID>
  <ArchiveName>sample string 4</ArchiveName>
  <ArchivedBy>2efefa0c-7844-4f40-a439-8ef95e1c3de7</ArchivedBy>
  <ID>6ba8654a-fc1a-4154-acbe-8ab39a2bf3a5</ID>
  <Name>sample string 1</Name>
  <RowType>1</RowType>
  <SiteID>21554c07-2aa8-4153-93e7-3bb4200a5d75</SiteID>
</Archive>

application/json, text/json

Sample

{
  "ID": "6ba8654a-fc1a-4154-acbe-8ab39a2bf3a5",
  "SiteID": "21554c07-2aa8-4153-93e7-3bb4200a5d75",
  "AncestorType": 64,
  "AncestorID": "9f42c192-d7dc-4ab7-bae5-82343ed65d0a",
  "Name": "sample string 1",
  "AncestorName": "sample string 2",
  "RowType": 1,
  "ArchivedBy": "2efefa0c-7844-4f40-a439-8ef95e1c3de7",
  "ArchiveName": "sample string 4",
  "ArchiveComment": "sample string 5",
  "ArchiveID": "d52c1b70-8fe9-4304-85aa-102a397b2dd3"
}