GET api/Document/GetDocumentPropertiesDetails/{apiClientID}/{documentID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
apiClientID | string |
Required |
|
documentID | string |
Required |
Body Parameters
None.
Response Information
Resource Description
DocumentPropertiesDetailsName | Description | Type | Additional information |
---|---|---|---|
apiClientID | string |
None. |
|
DocumentID | string |
None. |
|
Version | string |
None. |
|
DocumentName | string |
None. |
|
OrganisationID | string |
None. |
|
EntityType | string |
None. |
|
EntityCode | string |
None. |
|
EntityName | string |
None. |
|
DocumentCreationDate | string |
None. |
|
DocumentTypeCode | string |
None. |
|
DocumentTypeName | string |
None. |
|
DocumentDescription | string |
None. |
|
Subject | string |
None. |
|
Author | string |
None. |
|
User | string |
None. |
|
Leader | string |
None. |
|
Company | string |
None. |
|
Type | string |
None. |
|
KeyWords | string |
None. |
|
Aplication | string |
None. |
|
DocumentPublishTime | string |
None. |
|
Comment | string |
None. |
|
BusinessYear | integer |
None. |
|
PosterID | string |
None. |
|
DocumentAddTime | string |
None. |
|
ChangerID | string |
None. |
|
DocumentChangeTime | string |
None. |
|
Size | string |
None. |
|
ExpirationDate | string |
None. |
|
Signature | string |
None. |
|
ArchiveCode | string |
None. |
|
ArchiveStatus | string |
None. |
|
ArchivationTime | date |
None. |
|
Permission | string |
None. |
|
NumberOfAttachments | integer |
None. |
|
Coded | boolean |
None. |
|
CustomProperties | DocumentCustomProperties |
None. |
|
Comments | DocumentComments |
None. |
|
Folders | DocumentFolders |
None. |
|
Signatures | DocumentSignatures |
None. |
Response Formats
application/xml, text/xml
Sample:
<DocumentPropertiesDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <apiClientID>sample string 1</apiClientID> <DocumentID>sample string 2</DocumentID> <Version>sample string 3</Version> <DocumentName>sample string 4</DocumentName> <OrganisationID>sample string 5</OrganisationID> <EntityType>sample string 6</EntityType> <EntityCode>sample string 7</EntityCode> <EntityName>sample string 8</EntityName> <DocumentCreationDate>sample string 9</DocumentCreationDate> <DocumentTypeCode>sample string 10</DocumentTypeCode> <DocumentTypeName>sample string 11</DocumentTypeName> <DocumentDescription>sample string 12</DocumentDescription> <Subject>sample string 13</Subject> <Author>sample string 14</Author> <User>sample string 15</User> <Leader>sample string 16</Leader> <Company>sample string 17</Company> <Type>sample string 18</Type> <KeyWords>sample string 19</KeyWords> <Aplication>sample string 20</Aplication> <DocumentPublishTime>sample string 21</DocumentPublishTime> <Comment>sample string 22</Comment> <BusinessYear>23</BusinessYear> <PosterID>sample string 24</PosterID> <DocumentAddTime>sample string 25</DocumentAddTime> <ChangerID>sample string 26</ChangerID> <DocumentChangeTime>sample string 27</DocumentChangeTime> <Size>sample string 28</Size> <ExpirationDate>sample string 29</ExpirationDate> <Signature>sample string 30</Signature> <ArchiveCode>sample string 31</ArchiveCode> <ArchiveStatus>sample string 32</ArchiveStatus> <ArchivationTime>2024-11-21T15:30:21.7877423+01:00</ArchivationTime> <Permission>sample string 33</Permission> <NumberOfAttachments>34</NumberOfAttachments> <Coded>true</Coded> <CustomProperties> <CustomProperty> <Property>sample string 1</Property> <Value>sample string 2</Value> </CustomProperty> <CustomProperty> <Property>sample string 1</Property> <Value>sample string 2</Value> </CustomProperty> </CustomProperties> <Comments> <Comment> <CommentTime>sample string 1</CommentTime> <DocummentVersion>2</DocummentVersion> <Commenter>sample string 3</Commenter> <CommentBody>sample string 4</CommentBody> </Comment> <Comment> <CommentTime>sample string 1</CommentTime> <DocummentVersion>2</DocummentVersion> <Commenter>sample string 3</Commenter> <CommentBody>sample string 4</CommentBody> </Comment> </Comments> <Folders> <Folder> <FolderID>sample string 1</FolderID> <FolderCode>sample string 2</FolderCode> <FolderName>sample string 3</FolderName> <OrganisationID>4</OrganisationID> <AdministratorID>sample string 5</AdministratorID> <Status>sample string 6</Status> </Folder> <Folder> <FolderID>sample string 1</FolderID> <FolderCode>sample string 2</FolderCode> <FolderName>sample string 3</FolderName> <OrganisationID>4</OrganisationID> <AdministratorID>sample string 5</AdministratorID> <Status>sample string 6</Status> </Folder> </Folders> <Signatures> <Signature> <Signer>sample string 1</Signer> <Issuer>sample string 2</Issuer> <Validity>true</Validity> <Integrity>true</Integrity> <SigningTime>sample string 5</SigningTime> <TimeStamp>sample string 6</TimeStamp> <Reason>sample string 7</Reason> </Signature> <Signature> <Signer>sample string 1</Signer> <Issuer>sample string 2</Issuer> <Validity>true</Validity> <Integrity>true</Integrity> <SigningTime>sample string 5</SigningTime> <TimeStamp>sample string 6</TimeStamp> <Reason>sample string 7</Reason> </Signature> </Signatures> </DocumentPropertiesDetails>