Method CompressDocuments

CompressDocuments(String, CompressionOptionsContract)

Compress the documents

Declaration

string CompressDocuments(string connectionId, CompressionOptionsContract options)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
CompressionOptionsContract	options	Compression options parameters. See also CompressionOptionsContract

Returns

Type	Description
System.String	FileId of the ZIP file.

Examples

POST https://YourServerName/InfoShare/Json/DocumentProcessing/CompressDocuments

Example for a compress documents.

{
   "connectionId": "3c82780c-d086-4564-ab20-915fc2182620",
   "options": {
     "Password": "testPassword",
     "AddOverlay": "false",
     "AddAnnotations": "false",
     "Documents": [{
       "DocumentId": "18bec571-92d1-4adc-9088-789ac2feb3a4",
       "DocumentDataId": "28bec571-92d1-4adc-9088-789ac2feb3a5",
       "RenditionId": "38bec571-92d1-4adc-9088-789ac2feb3a6",
       "VersionId": "48bec571-92d1-4adc-9088-789ac2feb3a7"
       }, {
       "DocumentId": "58bec571-92d1-4adc-9088-789ac2feb3a4",
       "DocumentDataId": "68bec571-92d1-4adc-9088-789ac2feb3a4".
       "RenditionId": "78bec571-92d1-4adc-9088-789ac2feb3a4",
       "VersionId": "88bec571-92d1-4adc-9088-789ac2feb3a4" }]
       }
}

Response:

{
   "CompressDocumentsResult": "08bec571-92d1-4adc-9088-789ac2feb3a4"
}