GET 1.0/{InstanceId}/Documents/{DocumentId}/Versions

Retrieves all versions of a specific document

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

string

Required

DocumentId

The ID of the document whose version information is to be retrieved

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of DocumentVersion objects

Collection of DocumentVersion
API Parameter Details
NameDescriptionTypeAdditional information
Id

The ID of this document version

integer

None.

MajorVersion

The major version of the two-part version number

integer

None.

MinorVersion

The minor version of the two-part version number

integer

None.

CheckInDate

The date that this version of the document was checked in

date

None.

CheckInUserCode

The 4 character string representing the ID of the user that checked in this document

string

None.

CheckInUserCloudGUID

The GUID of the user who checked in the document

string

None.

CheckInUserName

The UserName of the user who checked in the document

string

None.

CheckInComments

Optional comments that were entered when the document was checked in

string

None.

CheckOutDate

The date that this version of the document was checked out

date

None.

CheckOutUserCode

The 4 character string representing the ID of the user that checked out this document

string

None.

CheckOutUserCloudGUID

The GUID of the user who checked out this document

string

None.

CheckOutUserName

The UserName of the user who checked out this document

string

None.

CheckOutComments

Optional comments that were entered when the document was checked out

string

None.

FileCreatedDate

The date the file related to this version of the document was created on disk

date

None.

FileModifiedDate

The date the file related to this version of the document was modified on disk

date

None.

FileLastReadDate

The date the file related to this version of the document was read from disk

date

None.

FileSize

The size in bytes of the File related to this version of the document

integer

None.

FileOriginalName

The name of the original file that was uploaded to create this version of the document

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "MajorVersion": 2,
    "MinorVersion": 3,
    "CheckInDate": "2025-05-19T14:42:44.2442781+01:00",
    "CheckInUserCode": "sample string 4",
    "CheckInUserCloudGUID": "sample string 5",
    "CheckInUserName": "sample string 6",
    "CheckInComments": "sample string 7",
    "CheckOutDate": "2025-05-19T14:42:44.2442781+01:00",
    "CheckOutUserCode": "sample string 8",
    "CheckOutUserCloudGUID": "sample string 9",
    "CheckOutUserName": "sample string 10",
    "CheckOutComments": "sample string 11",
    "FileCreatedDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileModifiedDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileLastReadDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileSize": 12,
    "FileOriginalName": "sample string 13"
  },
  {
    "Id": 1,
    "MajorVersion": 2,
    "MinorVersion": 3,
    "CheckInDate": "2025-05-19T14:42:44.2442781+01:00",
    "CheckInUserCode": "sample string 4",
    "CheckInUserCloudGUID": "sample string 5",
    "CheckInUserName": "sample string 6",
    "CheckInComments": "sample string 7",
    "CheckOutDate": "2025-05-19T14:42:44.2442781+01:00",
    "CheckOutUserCode": "sample string 8",
    "CheckOutUserCloudGUID": "sample string 9",
    "CheckOutUserName": "sample string 10",
    "CheckOutComments": "sample string 11",
    "FileCreatedDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileModifiedDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileLastReadDate": "2025-05-19T14:42:44.2442781+01:00",
    "FileSize": 12,
    "FileOriginalName": "sample string 13"
  }
]