Back

GET archives/{id}

Read an archive for the given archive Id

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id 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
ID globally unique identifier ReadOnly

ID of the given archive.
SiteID globally unique identifier ReadOnly

ID of the site for the given archive.
AncestorType byte ReadOnly

Ancestor type of the given archived object.
AncestorID globally unique identifier ReadOnly

Ancestor ID of the given archived object.
Name string ReadOnly

Name of the given archived object.
AncestorName string ReadOnly

Name of the ancestor of the given archive object.
RowType integer ReadOnly

Row type of the given archived object.
ArchiveDate string ReadOnly

Date the given archive was created.
ArchivedBy globally unique identifier ReadOnly

ID of the individual that created the given archive.
ArchiveName string ReadOnly

Name of the given archive.
ArchiveComment string ReadOnly

Comment about the given archive.
ArchiveID 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>177ea365-734f-4161-a928-f9a730928078</AncestorID>
  <AncestorName>sample string 2</AncestorName>
  <AncestorType>64</AncestorType>
  <ArchiveComment>sample string 5</ArchiveComment>
  <ArchiveID>491fe3e5-c7c5-4851-8de6-5924b194d7d5</ArchiveID>
  <ArchiveName>sample string 4</ArchiveName>
  <ArchivedBy>0edcf923-2e9f-4dc0-92ad-56707995e772</ArchivedBy>
  <ID>f9ccdf77-ff57-49a4-b2a6-94a64e3270f3</ID>
  <Name>sample string 1</Name>
  <RowType>1</RowType>
  <SiteID>293cb2ce-9008-49f6-a4ba-f5026fb5c21b</SiteID>
</Archive>

application/json, text/json

Sample
{
  "ID": "f9ccdf77-ff57-49a4-b2a6-94a64e3270f3",
  "SiteID": "293cb2ce-9008-49f6-a4ba-f5026fb5c21b",
  "AncestorType": 64,
  "AncestorID": "177ea365-734f-4161-a928-f9a730928078",
  "Name": "sample string 1",
  "AncestorName": "sample string 2",
  "RowType": 1,
  "ArchivedBy": "0edcf923-2e9f-4dc0-92ad-56707995e772",
  "ArchiveName": "sample string 4",
  "ArchiveComment": "sample string 5",
  "ArchiveID": "491fe3e5-c7c5-4851-8de6-5924b194d7d5"
}