GetDocument |
This Web service operation is used to fetch the details of a document including the metadata properties and the document. This Web service operation is part of the Document Store Web service interface in the Repository service group. When the URL of a specific document within the repository is provided to the SOAP request, the details of that document are returned as the response, and the document is downloaded to the location: <Cordys Installation Folder>/content/downloadcontent.
SOAP Request
<ns:GetDocument>
<!-- Complete path to the document starting from document root -->
<ns:DocumentURL fetchContent="true/false"></ns:DocumentURL>
</ns:GetDocument>
Request Parameters
Parameter |
Description |
|---|---|
DocumentURL |
Complete path to the document starting from the document root and separated by a forward slash (/). If fetchContent=false, the response will contain only the metadata details of the document, including all the system defined and user defined properties. If fetchContent=true, the response will contain metadata details of the document, including all the system defined and user defined properties, and the document will be downloaded to <Cordys Installation Folder>/content/downloadcontent. |
SOAP Response
<ns:GetDocumentResponse>
<!--type: string-->
<ns:DocumentName>documentname</ns:DocumentName>
<ns:DocumentContent/>
<ns:Folder>folder path</ns:Folder>
<ns:Properties>
<!--type: string-->
<ns:MimeType>html</ns:MimeType>
<!--type: dateTime-->
<ns:LastModified>2009-05-16T18:12:28</ns:LastModified>
<!--Zero or more repetitions:-->
<ns:Property>
<!--type: string-->
<ns:Name>some string name</ns:Name>
<!--type: string-->
<ns:Value>some string value</ns:Value>
<!-- Optional -->
<ns:CategoryID>category id in CS</ns:CategoryID>
</ns:Property>
</ns:Properties>
</ns:GetDocumentResponse>
Response Parameters
Parameter |
Description |
|---|---|
DocumentName |
The name of the document. |
DocumentContent |
If the document was uploaded with the streaming option, that is, isUrl=true using the CreateDocument request, then this element will have an attribute isLocation as true, implying that the document content is saved to CORDYS_INSTALL_DIR/content/downloadcontent folder. Otherwise, the element contains inline text that was supplied to the CreateDocument request when isUrl was set to false. Note: The creation and retrieval of the document with the document content as inline text in the SOAP request or response has been deprecated. Consumers must leverage streaming option for optimal performance and resource consumption. |
Folder |
The folder location of the document. |
Properties |
The document can contain the following set of properties:
|
| Property | Each property corresponds to one property name and its value attached to this document. |