Index | Method | Request(s) | Response | Description | ||||
---|---|---|---|---|---|---|---|---|
1 | merge |
sid docIds targetFolderId fileName |
merges a set of documents into a single PDF | |||||
2 | create |
sid document |
document | creates a new document using the uploaded chunks; the user can completely customize the document through a value object containing the document's metadata; returns the newly created document. | ||||
3 | checkin |
sid docId comment filename release docVO |
checks in an existing document to create a new version, it uses the uploaded chunks. | |||||
4 | downloadChunk |
sid docId version start length |
Download a fragment of the document | |||||
5 | uploadChunk |
sid content |
Uploads a new chunk in the current upload session | |||||
6 | deleteChunks |
sid |
Deletes all the chunks in the current upload session |
merges a set of documents into a single PDF
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | ||||||
docIds
|
Long | Y | Y | |||||
targetFolderId
|
Long | Y | dentifier of the folder that will receive the merged PDF | |||||
fileName
|
String | Y | file name of the merged PDF |
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
|
WSDocument | Y | ||||||
id
|
Long | Y | unique identifier | |||||
fileSize
|
Long | Y | ||||||
status
|
Int | 0 = unlocked, 1 = checked out, 2 = locked | ||||||
exportStatus
|
Int | |||||||
version
|
String | |||||||
fileVersion
|
String | |||||||
date
|
String | Y | last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | |||||
publisher
|
String | |||||||
publisherId
|
Long | |||||||
creator
|
String | |||||||
creatorId
|
Long | |||||||
type
|
String | Y | ||||||
lockUserId
|
Long | |||||||
creation
|
String | the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
fileName
|
String | Y | ||||||
indexed
|
Int | 0 = to index, 1 = indexed, 2 = skip indexing | ||||||
signed
|
Int | |||||||
stamped
|
Int | 1 if the document contains at least one stamp | ||||||
tags
|
String | Y | tags applied to the document | |||||
folderId
|
Long | Y | parent folder | |||||
templateId
|
Long | id of the template assigned to the document | ||||||
customId
|
String | unique custom identifier | ||||||
immutable
|
Int | 0 = not immutable, 1 = immutable | ||||||
digest
|
String | |||||||
exportName
|
String | |||||||
exportId
|
Long | |||||||
docRef
|
Long | used for aliases, refers to another document | ||||||
docRefType
|
String | if used, defines the reference type (use pdf for the PDF Conversion) | ||||||
deleteUserId
|
Long | user that has deleted the document | ||||||
attributes
|
WSAttribute | Y | array of attributes | |||||
name
|
String | Y | name of the attribute | |||||
stringValue
|
String | |||||||
intValue
|
Long | |||||||
doubleValue
|
Double | |||||||
dateValue
|
String | the date value; format must be 'yyyy-MM-dd' | ||||||
type
|
Int | Y | 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section | |||||
mandatory
|
Int | Y | ||||||
hidden
|
Int | Y | ||||||
readonly
|
Int | Y | ||||||
position
|
Int | |||||||
label
|
String | |||||||
editor
|
Int | Y | 0 = free, 1 = preset | |||||
setId
|
Long | Id of the attribute set | ||||||
multiple
|
Int | Y | 0 = single value, 1 = one or more values | |||||
parent
|
String | The reference attribute name, used for multi value attributes | ||||||
dependsOn
|
String | Name of another attribute on which the value of this attribute also depends, used for managing linked presets | ||||||
stringValues
|
String | Read only. In case of multiple string values, contains the values separated by a comma | ||||||
validation
|
String | Optional validation script | ||||||
initialization
|
String | Optional initialization script | ||||||
language
|
String | language of the document; See specification | ||||||
summary
|
String | contains the snippet search text | ||||||
score
|
Integer | full text search score | ||||||
icon
|
String | |||||||
comment
|
String | |||||||
lastModified
|
String | |||||||
rating
|
Integer | |||||||
workflowStatus
|
String | current workflow's status where the document is in | ||||||
workflowStatusDisplay
|
String | current workflow's status display informations | ||||||
color
|
String | optional color assigned to the document | ||||||
published
|
Int | if it is not set to 1, the document is marked as not published | ||||||
startPublishing
|
String | |||||||
stopPublishing
|
String | |||||||
pages
|
Int | number of pages (default 1) | ||||||
nature
|
Int | 0 = document, 1 = form | ||||||
formId
|
Long | the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
passwordProtected
|
Integer | indicates whether the document is protected by a password | ||||||
ocrTemplateId
|
Long | identifier of the Zonal OCR template to use to process this document | ||||||
ocrd
|
Int | indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed | ||||||
barcodeTemplateId
|
Long | identifier of the barcode template to use to process this document | ||||||
barcoded
|
Int | indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed |
creates a new document using the uploaded chunks; the user can completely customize the document through a value object containing the document's metadata; returns the newly created document.
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | ||||||
document
|
WSDocument | Y | ||||||
id
|
Long | Y | unique identifier | |||||
fileSize
|
Long | Y | ||||||
status
|
Int | 0 = unlocked, 1 = checked out, 2 = locked | ||||||
exportStatus
|
Int | |||||||
version
|
String | |||||||
fileVersion
|
String | |||||||
date
|
String | Y | last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | |||||
publisher
|
String | |||||||
publisherId
|
Long | |||||||
creator
|
String | |||||||
creatorId
|
Long | |||||||
type
|
String | Y | ||||||
lockUserId
|
Long | |||||||
creation
|
String | the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
fileName
|
String | Y | ||||||
indexed
|
Int | 0 = to index, 1 = indexed, 2 = skip indexing | ||||||
signed
|
Int | |||||||
stamped
|
Int | 1 if the document contains at least one stamp | ||||||
tags
|
String | Y | tags applied to the document | |||||
folderId
|
Long | Y | parent folder | |||||
templateId
|
Long | id of the template assigned to the document | ||||||
customId
|
String | unique custom identifier | ||||||
immutable
|
Int | 0 = not immutable, 1 = immutable | ||||||
digest
|
String | |||||||
exportName
|
String | |||||||
exportId
|
Long | |||||||
docRef
|
Long | used for aliases, refers to another document | ||||||
docRefType
|
String | if used, defines the reference type (use pdf for the PDF Conversion) | ||||||
deleteUserId
|
Long | user that has deleted the document | ||||||
attributes
|
WSAttribute | Y | array of attributes | |||||
name
|
String | Y | name of the attribute | |||||
stringValue
|
String | |||||||
intValue
|
Long | |||||||
doubleValue
|
Double | |||||||
dateValue
|
String | the date value; format must be 'yyyy-MM-dd' | ||||||
type
|
Int | Y | 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section | |||||
mandatory
|
Int | Y | ||||||
hidden
|
Int | Y | ||||||
readonly
|
Int | Y | ||||||
position
|
Int | |||||||
label
|
String | |||||||
editor
|
Int | Y | 0 = free, 1 = preset | |||||
setId
|
Long | Id of the attribute set | ||||||
multiple
|
Int | Y | 0 = single value, 1 = one or more values | |||||
parent
|
String | The reference attribute name, used for multi value attributes | ||||||
dependsOn
|
String | Name of another attribute on which the value of this attribute also depends, used for managing linked presets | ||||||
stringValues
|
String | Read only. In case of multiple string values, contains the values separated by a comma | ||||||
validation
|
String | Optional validation script | ||||||
initialization
|
String | Optional initialization script | ||||||
language
|
String | language of the document; See specification | ||||||
summary
|
String | contains the snippet search text | ||||||
score
|
Integer | full text search score | ||||||
icon
|
String | |||||||
comment
|
String | |||||||
lastModified
|
String | |||||||
rating
|
Integer | |||||||
workflowStatus
|
String | current workflow's status where the document is in | ||||||
workflowStatusDisplay
|
String | current workflow's status display informations | ||||||
color
|
String | optional color assigned to the document | ||||||
published
|
Int | if it is not set to 1, the document is marked as not published | ||||||
startPublishing
|
String | |||||||
stopPublishing
|
String | |||||||
pages
|
Int | number of pages (default 1) | ||||||
nature
|
Int | 0 = document, 1 = form | ||||||
formId
|
Long | the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
passwordProtected
|
Integer | indicates whether the document is protected by a password | ||||||
ocrTemplateId
|
Long | identifier of the Zonal OCR template to use to process this document | ||||||
ocrd
|
Int | indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed | ||||||
barcodeTemplateId
|
Long | identifier of the barcode template to use to process this document | ||||||
barcoded
|
Int | indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed |
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
document
|
WSDocument | Y | ||||||
id
|
Long | Y | unique identifier | |||||
fileSize
|
Long | Y | ||||||
status
|
Int | 0 = unlocked, 1 = checked out, 2 = locked | ||||||
exportStatus
|
Int | |||||||
version
|
String | |||||||
fileVersion
|
String | |||||||
date
|
String | Y | last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | |||||
publisher
|
String | |||||||
publisherId
|
Long | |||||||
creator
|
String | |||||||
creatorId
|
Long | |||||||
type
|
String | Y | ||||||
lockUserId
|
Long | |||||||
creation
|
String | the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
fileName
|
String | Y | ||||||
indexed
|
Int | 0 = to index, 1 = indexed, 2 = skip indexing | ||||||
signed
|
Int | |||||||
stamped
|
Int | 1 if the document contains at least one stamp | ||||||
tags
|
String | Y | tags applied to the document | |||||
folderId
|
Long | Y | parent folder | |||||
templateId
|
Long | id of the template assigned to the document | ||||||
customId
|
String | unique custom identifier | ||||||
immutable
|
Int | 0 = not immutable, 1 = immutable | ||||||
digest
|
String | |||||||
exportName
|
String | |||||||
exportId
|
Long | |||||||
docRef
|
Long | used for aliases, refers to another document | ||||||
docRefType
|
String | if used, defines the reference type (use pdf for the PDF Conversion) | ||||||
deleteUserId
|
Long | user that has deleted the document | ||||||
attributes
|
WSAttribute | Y | array of attributes | |||||
name
|
String | Y | name of the attribute | |||||
stringValue
|
String | |||||||
intValue
|
Long | |||||||
doubleValue
|
Double | |||||||
dateValue
|
String | the date value; format must be 'yyyy-MM-dd' | ||||||
type
|
Int | Y | 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section | |||||
mandatory
|
Int | Y | ||||||
hidden
|
Int | Y | ||||||
readonly
|
Int | Y | ||||||
position
|
Int | |||||||
label
|
String | |||||||
editor
|
Int | Y | 0 = free, 1 = preset | |||||
setId
|
Long | Id of the attribute set | ||||||
multiple
|
Int | Y | 0 = single value, 1 = one or more values | |||||
parent
|
String | The reference attribute name, used for multi value attributes | ||||||
dependsOn
|
String | Name of another attribute on which the value of this attribute also depends, used for managing linked presets | ||||||
stringValues
|
String | Read only. In case of multiple string values, contains the values separated by a comma | ||||||
validation
|
String | Optional validation script | ||||||
initialization
|
String | Optional initialization script | ||||||
language
|
String | language of the document; See specification | ||||||
summary
|
String | contains the snippet search text | ||||||
score
|
Integer | full text search score | ||||||
icon
|
String | |||||||
comment
|
String | |||||||
lastModified
|
String | |||||||
rating
|
Integer | |||||||
workflowStatus
|
String | current workflow's status where the document is in | ||||||
workflowStatusDisplay
|
String | current workflow's status display informations | ||||||
color
|
String | optional color assigned to the document | ||||||
published
|
Int | if it is not set to 1, the document is marked as not published | ||||||
startPublishing
|
String | |||||||
stopPublishing
|
String | |||||||
pages
|
Int | number of pages (default 1) | ||||||
nature
|
Int | 0 = document, 1 = form | ||||||
formId
|
Long | the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
passwordProtected
|
Integer | indicates whether the document is protected by a password | ||||||
ocrTemplateId
|
Long | identifier of the Zonal OCR template to use to process this document | ||||||
ocrd
|
Int | indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed | ||||||
barcodeTemplateId
|
Long | identifier of the barcode template to use to process this document | ||||||
barcoded
|
Int | indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed |
checks in an existing document to create a new version, it uses the uploaded chunks.
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | ||||||
docId
|
Long | Y | ||||||
comment
|
String | Y | ||||||
filename
|
String | Y | ||||||
release
|
Boolean | Y | true if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1) | |||||
docVO
|
WSDocument | Y | optional, contains the metadata to update during the checkin | |||||
id
|
Long | Y | unique identifier | |||||
fileSize
|
Long | Y | ||||||
status
|
Int | 0 = unlocked, 1 = checked out, 2 = locked | ||||||
exportStatus
|
Int | |||||||
version
|
String | |||||||
fileVersion
|
String | |||||||
date
|
String | Y | last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | |||||
publisher
|
String | |||||||
publisherId
|
Long | |||||||
creator
|
String | |||||||
creatorId
|
Long | |||||||
type
|
String | Y | ||||||
lockUserId
|
Long | |||||||
creation
|
String | the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
fileName
|
String | Y | ||||||
indexed
|
Int | 0 = to index, 1 = indexed, 2 = skip indexing | ||||||
signed
|
Int | |||||||
stamped
|
Int | 1 if the document contains at least one stamp | ||||||
tags
|
String | Y | tags applied to the document | |||||
folderId
|
Long | Y | parent folder | |||||
templateId
|
Long | id of the template assigned to the document | ||||||
customId
|
String | unique custom identifier | ||||||
immutable
|
Int | 0 = not immutable, 1 = immutable | ||||||
digest
|
String | |||||||
exportName
|
String | |||||||
exportId
|
Long | |||||||
docRef
|
Long | used for aliases, refers to another document | ||||||
docRefType
|
String | if used, defines the reference type (use pdf for the PDF Conversion) | ||||||
deleteUserId
|
Long | user that has deleted the document | ||||||
attributes
|
WSAttribute | Y | array of attributes | |||||
name
|
String | Y | name of the attribute | |||||
stringValue
|
String | |||||||
intValue
|
Long | |||||||
doubleValue
|
Double | |||||||
dateValue
|
String | the date value; format must be 'yyyy-MM-dd' | ||||||
type
|
Int | Y | 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section | |||||
mandatory
|
Int | Y | ||||||
hidden
|
Int | Y | ||||||
readonly
|
Int | Y | ||||||
position
|
Int | |||||||
label
|
String | |||||||
editor
|
Int | Y | 0 = free, 1 = preset | |||||
setId
|
Long | Id of the attribute set | ||||||
multiple
|
Int | Y | 0 = single value, 1 = one or more values | |||||
parent
|
String | The reference attribute name, used for multi value attributes | ||||||
dependsOn
|
String | Name of another attribute on which the value of this attribute also depends, used for managing linked presets | ||||||
stringValues
|
String | Read only. In case of multiple string values, contains the values separated by a comma | ||||||
validation
|
String | Optional validation script | ||||||
initialization
|
String | Optional initialization script | ||||||
language
|
String | language of the document; See specification | ||||||
summary
|
String | contains the snippet search text | ||||||
score
|
Integer | full text search score | ||||||
icon
|
String | |||||||
comment
|
String | |||||||
lastModified
|
String | |||||||
rating
|
Integer | |||||||
workflowStatus
|
String | current workflow's status where the document is in | ||||||
workflowStatusDisplay
|
String | current workflow's status display informations | ||||||
color
|
String | optional color assigned to the document | ||||||
published
|
Int | if it is not set to 1, the document is marked as not published | ||||||
startPublishing
|
String | |||||||
stopPublishing
|
String | |||||||
pages
|
Int | number of pages (default 1) | ||||||
nature
|
Int | 0 = document, 1 = form | ||||||
formId
|
Long | the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' | ||||||
passwordProtected
|
Integer | indicates whether the document is protected by a password | ||||||
ocrTemplateId
|
Long | identifier of the Zonal OCR template to use to process this document | ||||||
ocrd
|
Int | indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed | ||||||
barcodeTemplateId
|
Long | identifier of the barcode template to use to process this document | ||||||
barcoded
|
Int | indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed |
Download a fragment of the document
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | ||||||
docId
|
Long | Y | ||||||
version
|
String | Y | ||||||
start
|
Long | Y | the start byte | |||||
length
|
Long | Y | number of bytes to get |
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
|
DataHandler | Y |
Uploads a new chunk in the current upload session
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y | ||||||
content
|
DataHandler | Y | the raw content of the chunk |
Deletes all the chunks in the current upload session
Name | Type | Required | Multiple | Description | ||||
---|---|---|---|---|---|---|---|---|
sid
|
String | Y |