DocuWare Platform Service Description

The service provides you an easy access to DocuWare functions in a Web based environment.

DocuWare WebClient

Open the DocuWare WebClient.

Resources of Documentation

The DocuWare Developer Documentation.
For all the developers interested in our different kind of APIs and extensions of DocuWare.
The DocuWare Platform .NET API reference.
A comprehensive documentation which is a good starting point for .NET developers using the DocuWare Platform. You can find code examples there and basic principles are explained.
The DocuWare Platform documentation pages.
This is a list of How tos.
The DocuWare Platform resources reference.
A complete list of all resources provided by the DocuWare Platform.
A data structure browser.
Browse and inspect the data structures.
The plain XML schemas.
If you want to generate code for the used data structures use this resource as input for your code generator.

Browse the DocuWare Platform

List Organizations.
View all your organizations you have access to. From there you can browse other resources like file cabinets, dialogs, ...

For System Administrators

This is DocuWare version 7.9.0.4832.
The log of the DocuWare Platform.
In case you want to investigate a problem this should be the first source to look at.
The DocuWare Platform HTML test client
A client where you can easily check basic functions.

Named URI templates

URI templates can be used from a client to directly access resources. For instance, if you have a document id and the according file cabinet id, you can use the URI template with the name document which returns you the specified document.

export

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/Index?q={q}&fields={fields}&sortOrder={sortOrder}
Verb Accepts Produces
POST ExportSettings */*

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
fields (optional) : String, String, ...
A list of user index field names which appear in the result.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.

archiveDocument

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/ArchiveDocument?id={id}
Verb Accepts Produces
POST ExportSettings */*

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : Int32
The identifier of the document.

importDocument

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/ImportDocument
Verb Accepts Produces
POST */* ImportResult

Parameters:

Name Description
fileCabinetId : String

controllerWorkflows

/DocuWare/Platform/Workflow/ControllerWorkflows
Verb Accepts Produces
GET none Workflows

controllerWorkflow

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}
Verb Accepts Produces
GET none Workflow

Parameters:

Name Description
id : String

controllerWorkflowTasksCount

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}/Count
Verb Accepts Produces
GET none WorkflowTasksCount

Parameters:

Name Description
id : String

controllerWorkflowTasks

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}/Tasks?sortOrder={sortOrder}&start={start}&count={count}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}
Verb Accepts Produces
GET none WorkflowTasks
POST TasksQuery WorkflowTasks

Parameters:

Name Description
id : String
sortOrder (optional) : String, String, ...
start (optional) : Int32
count (optional) : Int32
format (optional) : String
encodingName (optional) : String
Encoding to be used for csv export.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.

controllerWorkflowTask

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}?loadColumnValues={loadColumnValues}&maintenanceMode={maintenanceMode}
Verb Accepts Produces
GET none WorkflowTasks

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
loadColumnValues (optional, True) : Boolean
maintenanceMode (optional, False) : Boolean

controllerWorkflowConfirm

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/Confirm
Verb Accepts Produces
POST ConfirmedData none

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32

controllerWorkflowStampBestPosition

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampBestPosition
Verb Accepts Produces
POST StampPositionData DWPoint

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32

controllerWorkflowDecisions

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}?ignoreErrors={ignoreErrors}
Verb Accepts Produces
GET none Decision

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32
ignoreErrors (optional, False) : Boolean

controllerWorkflowStampDecisions

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampDecisions?ignoreErrors={ignoreErrors}
Verb Accepts Produces
GET none Decision

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32
ignoreErrors (optional, False) : Boolean

controllerWorkflowStampSettings

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/StampSettings
Verb Accepts Produces
GET none DecisionsStampSettings

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String

workflowInstance

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Instance
Verb Accepts Produces
GET none text/plain Instance
DELETE none text/plain Instance

Parameters:

Name Description
workflowId : String
instanceId : String

controllerReassignTask

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Reassign
Verb Accepts Produces
POST ReassignmentData none

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String

designerWorkflows

/DocuWare/Platform/Workflow/DesignerWorkflows
Verb Accepts Produces
GET none DesignerWorkflows

designerWorkflow

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}
Verb Accepts Produces
GET none DesignerWorkflow

Parameters:

Name Description
id : String

designerWorkflowVersions

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions
Verb Accepts Produces
GET none DesignerWorkflowVersions

Parameters:

Name Description
id : String

designerWorkflowVersion

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions/{versionId}
Verb Accepts Produces
GET none DesignerWorkflowVersion

Parameters:

Name Description
id : String
versionId : String

designerWorkflowInstances

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Instances
Verb Accepts Produces
GET none DesignerInstances

Parameters:

Name Description
id : String

designerWorkflowWaitingInstances

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances
Verb Accepts Produces
GET none DesignerWaitingInstances

Parameters:

Name Description
id : String

designerWaitingInstance

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances/{instanceId}
Verb Accepts Produces
GET none DesignerWaitingInstance

Parameters:

Name Description
id : String
instanceId : String

designerContinueWaitingInstance

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances/{instanceId}/Continue
Verb Accepts Produces
POST none String

Parameters:

Name Description
id : String
instanceId : String

designerWorkflowVersionInstances

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions/{versionId}/Instances
Verb Accepts Produces
GET none DesignerInstances

Parameters:

Name Description
id : String
versionId : String

designerWorkflowInstance

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Instances/{instanceId}
Verb Accepts Produces
GET none DesignerInstance
DELETE none DesignerInstance

Parameters:

Name Description
id : String
instanceId : String

contentMerge

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ContentMerge
Verb Accepts Produces
POST ContentMergeOperationInfo Document
PUT ContentMergeOperationInfo Document

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

clippedDocuments

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ClippedDocuments?docId={docId}&operation={operation}
Verb Accepts Produces
POST IntegerList Document
PUT IntegerList Document

Parameters:

Name Description
docId : Int32
fileCabinetId : String
The identifier of the used file cabinet.
operation (optional) : ContentMergeOperation

contentDivide

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ContentDivide?docId={docId}
Verb Accepts Produces
POST ContentDivideOperationInfo DocumentsQueryResult
PUT ContentDivideOperationInfo DocumentsQueryResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
docId : Int32

processDocumentAction

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ProcessDocumentAction?docId={docId}
Perform specific action on document
Verb Accepts Produces
PUT DocumentActionInfo Document

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
docId : Int32
The identifier of the document.

batchUpdateFields

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/BatchDocumentsUpdateFields
Process update index fields in batch defined by a list of documents.
Verb Accepts Produces
POST BatchUpdateProcess BatchAppendKeywordValues BatchUpdateIndexFieldsResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

batchQueryUpdateFieldsOperation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/BatchQueryUpdateFields?fields={fields}&sortOrder={sortOrder}&q={q}&start={start}
Process update index fields in batch defined by a query.
Verb Accepts Produces
POST BatchUpdateProcessData BatchUpdateIndexFieldsResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
fields (optional) : String, String, ...
A list of user index field names which appear in the result.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.

createUserDefinedSearchOperation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/CreateUserDefinedSearch?q={q}
Creates a user defined search based on result list
Verb Accepts Produces
POST UserDefinedSearchInfo Dialog

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.

retrieveSequenceElement

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/RetrieveSequenceElement
Verb Accepts Produces
POST SequenceRequest SequenceResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

replicationData

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationData?additionalFields={additionalFields}&startAfterDocGuid={startAfterDocGuid}&pageSize={pageSize}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
additionalFields (optional) : String, String, ...
startAfterDocGuid : String
pageSize (optional) : Int32

replicationDeleteData

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationDeleteData
Verb Accepts Produces
POST none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

setupReplication

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/SetupReplication
Verb Accepts Produces
POST none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

replicationCabinetInfo

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationCabinetInfo
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

transfer

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Task/Transfer?storeDialogId={storeDialogId}
Verb Accepts Produces
POST FileCabinetTransferInfo DocumentsTransferInfo DocumentsQueryResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
storeDialogId : String
Id of the store dialog from which the document is stored

requestWorkflowsEntryPoint

/DocuWare/Platform/Workflow/RequestsWorkflows
Verb Accepts Produces
GET none String WorkflowRequests
POST RequestSettings String WorkflowRequests

requestTasks

/DocuWare/Platform/Workflow/RequestsWorkflows/Tasks?start={start}&count={count}&sortOrder={sortOrder}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}
Verb Accepts Produces
GET none RequestTasks
POST TasksQuery RequestTasks

Parameters:

Name Description
start (optional) : Int32
count (optional) : Int32
sortOrder (optional) : String, String, ...
format (optional) : String
encodingName (optional) : String
Encoding to be used for csv export.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.

workflowRequestTask

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}
Verb Accepts Produces
GET none RequestTask

Parameters:

Name Description
workflowId : String
taskId : String

requestTaskStampSettings

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/StampSettings
Verb Accepts Produces
GET none RequestDecisionsStampSettings

Parameters:

Name Description
workflowId : String
taskId : String

requestWorkflows

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows?start={start}&count={count}&sortOrder={sortOrder}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}
Verb Accepts Produces
GET none OwnWorkflows
POST TasksQuery OwnWorkflows

Parameters:

Name Description
start (optional) : Int32
count (optional) : Int32
sortOrder (optional) : String, String, ...
format (optional) : String
encodingName (optional) : String
Encoding to be used for csv export.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.

requestWorkflow

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Self
Verb Accepts Produces
GET none OwnWorkflow String
DELETE none OwnWorkflow String

Parameters:

Name Description
workflowId : String

requestTasksCount

/DocuWare/Platform/Workflow/RequestsWorkflows/TasksCount
Verb Accepts Produces
GET none WorkflowTasksCount

requestWorkflowsCount

/DocuWare/Platform/Workflow/RequestsWorkflows/WorkflowsCount
Verb Accepts Produces
GET none WorkflowTasksCount

requestWorkflowHistory

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/History
Verb Accepts Produces
GET none InstanceHistory

Parameters:

Name Description
workflowId : String

readStatus

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/ReadStatus
Verb Accepts Produces
PUT ReadStatus text/plain

Parameters:

Name Description
workflowId : String
taskId : String

confirmTask

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/Confirm
Verb Accepts Produces
POST RequestConfirmedData none

Parameters:

Name Description
workflowId : String
taskId : String

trashBin

/DocuWare/Platform/TrashBin
Verb Accepts Produces
GET none TrashBin

trashedDocuments

/DocuWare/Platform/TrashBin/Documents?q={q}&sortOrder={sortOrder}&start={start}&count={count}&calculateTotalCount={calculateTotalCount}
Verb Accepts Produces
GET none TrashBinDocumentsTableResult

Parameters:

Name Description
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.
calculateTotalCount (optional, True) : Boolean
A value indicating whether the total count of the documents should be calculated.

queryTrashedDocuments

/DocuWare/Platform/TrashBin/Query
Verb Accepts Produces
POST TrashBinQuery TrashBinDocumentsTableResult

countTrashedDocuments

/DocuWare/Platform/TrashBin/Count
Verb Accepts Produces
GET none CountResult

selectListsTrashedDocuments

/DocuWare/Platform/TrashBin/SelectLists?fieldName={fieldName}&q={q}&prefix={prefix}&start={start}&count={count}&sortDirection={sortDirection}
Gets typed select list values for a trash bin field with an optional prefix.
Verb Accepts Produces
GET none TypedSelectListResult

Parameters:

Name Description
fieldName : String
The name of the field for which the select list values are retrieved.
q (optional) : String
Returns elements that meet the specified condition.
prefix (optional) : String
The prefix of the returned select list values.
start (optional) : Int32
First result to return if block size is specified
count (optional) : Int32
Result will be returned on pages with that block size if specified. If set to default (0) select lists will be returned in one block using Limit parameter.
sortDirection (optional) : SortDirection
Define sort order of the select list

batchRestore

/DocuWare/Platform/TrashBin/BatchRestore
Verb Accepts Produces
POST BatchRestoreDocumentsSource BatchRestoreResult

batchDelete

/DocuWare/Platform/TrashBin/BatchDelete
Verb Accepts Produces
POST BatchDeleteDocumentsSource BatchDeleteResult

workflows

/DocuWare/Platform/Workflow/Workflows
Verb Accepts Produces
GET none Workflows

workflow

/DocuWare/Platform/Workflow/Workflows/{id}
Verb Accepts Produces
GET none Workflow

Parameters:

Name Description
id : String

tasksCount

/DocuWare/Platform/Workflow/Workflows/{id}/Count
Verb Accepts Produces
GET none WorkflowTasksCount

Parameters:

Name Description
id : String

tasks

/DocuWare/Platform/Workflow/Workflows/{id}/Tasks?sortOrder={sortOrder}&start={start}&count={count}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}
Verb Accepts Produces
GET none WorkflowTasks
POST TasksQuery WorkflowTasks

Parameters:

Name Description
id : String
sortOrder (optional) : String, String, ...
start (optional) : Int32
count (optional) : Int32
format (optional) : String
encodingName (optional) : String
Encoding to be used for csv export.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.

workflowTask

/DocuWare/Platform/Workflow/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}?loadColumnValues={loadColumnValues}
Verb Accepts Produces
GET none WorkflowTask

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
loadColumnValues (optional, True) : Boolean

workflowConfirm

/DocuWare/Platform/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/Confirm
Verb Accepts Produces
POST ConfirmedData none

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32

workflowStampBestPosition

/DocuWare/Platform/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampBestPosition
Verb Accepts Produces
POST StampPositionData DWPoint

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32

workflowDecisions

/DocuWare/Platform/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}?ignoreErrors={ignoreErrors}
Verb Accepts Produces
GET none Decision

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32
ignoreErrors (optional, False) : Boolean

workflowStampDecisions

/DocuWare/Platform/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampDecisions?ignoreErrors={ignoreErrors}
Verb Accepts Produces
GET none Decision

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String
decisionId : Int32
ignoreErrors (optional, False) : Boolean

workflowStampSettings

/DocuWare/Platform/Workflow/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/StampSettings
Verb Accepts Produces
GET none DecisionsStampSettings

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String

reassignTask

/DocuWare/Platform/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Reassign
Verb Accepts Produces
POST ReassignmentData none

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String

workflowReadStatus

/DocuWare/Platform/Workflow/Workflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/ReadStatus
Verb Accepts Produces
PUT ReadStatus text/plain

Parameters:

Name Description
workflowId : String
instanceId : String
taskId : String

workflowHistoryInstance

/DocuWare/Platform/Workflow/Workflows/{workflowId}/Instances/{instanceId}/History
Verb Accepts Produces
GET none InstanceHistory

Parameters:

Name Description
workflowId : String
instanceId : String

createPermanentUrl

/DocuWare/Platform/Account/PermanentUrl?clientSideChecksum={clientSideChecksum}
Enriches the specified URL with an encrypted identity.
Verb Accepts Produces
POST application/x-www-form-urlencoded text/plain

Parameters:

Name Description
clientSideChecksum (optional, False) : Boolean

credentialValidation

/DocuWare/Platform/Account/CredentialValidation?model={model}
Verb Accepts Produces
POST none text/plain

Parameters:

Name Description
model : LogOnModel

dialogsByFileCabinet

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs?dialogType={dialogType}
Gets dialogs.
Verb Accepts Produces
GET none DialogInfos

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
dialogType (optional) : DialogTypes, DialogTypes, ...
The dialog types to retrieve. You can specify multiple dialog types as matrix parameter.

dialog

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}?dialogType={dialogType}
Gets the full representation of a dialog.
Verb Accepts Produces
GET none Dialog

Parameters:

Name Description
id : String
The identifier of the used dialog.
fileCabinetId : String
The identifier of the used file cabinet.
dialogType (optional) : DialogTypes, DialogTypes, ...
The dialog types to retrieve. You can specify multiple dialog types as matrix parameter.

dialog

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}
Modifies the specified dialog (only for private task lists)
Verb Accepts Produces
POST UserDefinedSearchModifyInfo Dialog

Parameters:

Name Description
id : String
The identifier of the used dialog.
fileCabinetId : String
The identifier of the used file cabinet.

batchDialogUpdateFields

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/BatchUpdateFields?fields={fields}&sortOrder={sortOrder}
Process update index fields in batch defined by a dialog expression
Verb Accepts Produces
POST BatchUpdateProcess BatchUpdateIndexFieldsResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : String
The identifier of the used dialog.
fields (optional) : String, String, ...
A list of user index field names which appear in the result.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.

createUserDefinedSearch

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/CreateUserDefinedSearch
Creates a user defined search based on result list
Verb Accepts Produces
POST UserDefinedSearchInfo Dialog

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : String
The identifier of the used dialog.

clientSideValidation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/Validate
Perform client side validation defined in the specified dialog.
Verb Accepts Produces
POST DocumentIndexFields none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : String
The identifier of the used dialog.

documentDelete

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}
Deletes the specified document.
Verb Accepts Produces
DELETE none text/plain

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

document

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}
Gets the meta data of the specified document.
Verb Accepts Produces
GET none Document

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentAppendFiles

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}
Uploads new sections to a document. In order to upload new files to the specified document, the Content-Type header must be \"multipart/form-data\", and the body must be encoded this way.
Verb Accepts Produces
POST multipart/form-data Document

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentLatestVersion

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/LatestVersion
Gets the meta data of the latest version of a document.
Verb Accepts Produces
GET none Document

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documents

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents?q={q}&fields={fields}&sortOrder={sortOrder}&start={start}&msStart={msStart}&count={count}&format={format}&includeSuggestions={includeSuggestions}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}&calculateTotalCount={calculateTotalCount}
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
Verb Accepts Produces
GET none DocumentsQueryResult application/atom+xml

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
fields (optional) : String, String, ...
A list of user index field names which appear in the result.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
msStart (optional) : Int32
The number of documents plus 1 to be skipped. This parameter can be used for a Windows Explorer search integration: The Windows Explorer numerates the documents beginning with 1.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.
format (optional) : String
The format of the result list. Currently only the value feed is supported.
includeSuggestions (optional, False) : Boolean
A value indicating whether Intellix suggetstions to be included.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.
calculateTotalCount (optional, True) : Boolean
A value indicating whether the total count of the documents should be calculated.

uploadDocument

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents?processTextshot={processTextshot}&imageProcessing={imageProcessing}&redirect={redirect}&storeDialogId={storeDialogId}&checkFileNameForCheckinInfo={checkFileNameForCheckinInfo}
Adds a new document to the file cabinet.
Read more...
Verb Accepts Produces
POST Document InputDocument */* Document

Parameters:

Name Description
fileCabinetId : String
processTextshot (optional) : Boolean
This parameter specifies if the document is processed and a text shot is extracted for further processing. If this parameter is missing or true then the text shot is created after the document has been uploaded. If the parameter is false then the text shot is not created, and it is neccessary to upload the text shot with a subsequent request in order to benefit from any further text shot processing.
imageProcessing (optional) : Boolean
Define if image processing is executed when document is stored
redirect (optional) : String
After the request is successfully finished you are redirected to the specified URI.
storeDialogId (optional) : String
Id of the store dialog from which the document is stored
checkFileNameForCheckinInfo (optional) : Boolean
Define whether to check file name for check-in information.

documentIndexFields

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Fields
Retrieve or update document fields.
Verb Accepts Produces
GET none DocumentIndexFields
PUT DocumentIndexFields UpdateIndexFieldsInfo DocumentIndexFields
POST DocumentIndexFields UpdateIndexFieldsInfo DocumentIndexFields

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentTableFieldRows

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TableFieldRows?tableFieldName={tableFieldName}&start={start}&count={count}
Retrieve the value of specific table field of a document.
Verb Accepts Produces
GET none DocumentIndexFieldTable

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
tableFieldName : String
The db name of the table field
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.

intellixSuggestions

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Suggestions?normalizeCoordinates={normalizeCoordinates}
Retrieve simple field suggestions by the Intelligent Indexing Services.
Verb Accepts Produces
GET none SuggestionFields

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
normalizeCoordinates (optional, False) : Boolean
If this flag is true then the result coordinates orientation will be alligned with the page

tableFieldsIntellixSuggestions

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TableFieldsSuggestions?normalizeCoordinates={normalizeCoordinates}
Retrieve table field suggestions by the Intelligent Indexing Services.
Verb Accepts Produces
GET none SuggestionTableFields

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
normalizeCoordinates (optional, False) : Boolean
If this flag is true then the result coordinates orientation will be alligned with the page

positions

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Positions?q={q}&wholeWord={wholeWord}&ignoreCase={ignoreCase}&startSectionNumber={startSectionNumber}&startPage={startPage}&pageCount={pageCount}&rangeSearch={rangeSearch}&backward={backward}
Retrieve word positions of a phrase
Verb Accepts Produces
GET none DocumentWordSearchResult

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
q : String
Specifies the search phrase (words)
wholeWord (optional) : Boolean
Specifies whether to search for whole words. If this is set to true then only whe words are search instead od the phrase.
ignoreCase (optional) : Boolean
Specifies if the search is case insensitive.
startSectionNumber (optional) : Int32
Specifies the first section which is searched.
startPage (optional) : Int32
Specifies the first page which is searched.
pageCount (optional) : Int32
Specifies a number number of pages after the first page where a hit occur. If value is less than zero then all pages will be returned
rangeSearch (optional) : Boolean
If this flag is true then only the specified page range is searched. Otherwise the whole document starting at the specified page is searched until the specified number of pages are found.
backward (optional) : Boolean
If this flag is true then only the specified page range is searched. Otherwise the whole document starting at the specified page is serched until the specified number of pages are found.

documentsFileDownload

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/FileDownload?targetFileType={targetFileType}&keepAnnotations={keepAnnotations}&downloadFile={downloadFile}&autoPrint={autoPrint}&sendByEmail={sendByEmail}&layers={layers}&append={append}
Download customized document file
Verb Accepts Produces
GET none */*

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
targetFileType (optional) : FileDownloadType
keepAnnotations (optional) : Boolean
downloadFile (optional) : Boolean
autoPrint (optional) : Boolean
sendByEmail (optional) : Boolean
layers (optional) : Int32, Int32, ...
append (optional) : Int32, Int32, ...

documentContent

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Data?append={append}
Retrieve document content data of the document. If there is only one section it contain the section file otherwhise zip with all section files.
Verb Accepts Produces
GET none */*

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
append (optional) : Int32, Int32, ...

lockDocument

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Lock
Creates or removes a lock of a document.
Verb Accepts Produces
POST LockInfo text/plain
DELETE LockInfo text/plain

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

textAnnotation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TextAnnotation?ignoreMe={ignoreMe}
Get document's text annotation.
Verb Accepts Produces
GET none text/plain

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
ignoreMe (optional, False) : Boolean

xmlDSigContent

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/XmlDSigContent?verify={verify}
Get document XML Digital signatures content
Verb Accepts Produces
GET none XmlDSigContentType

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
verify (optional, False) : Boolean

checksumStatus

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/ChecksumStatus
Get a document's checksum status.
Verb Accepts Produces
GET none ChecksumStatusType

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentRights

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Rights
Checks if specific rights are valid for a document and retrieves them.
Verb Accepts Produces
POST Rights Rights

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentApplicationProperties

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentApplicationProperties
Provide functionality for custom application properties for a document.
Verb Accepts Produces
GET none DocumentApplicationProperties
POST DocumentApplicationProperties DocumentApplicationProperties

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentDocumentLinks

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentLinks?resultListId={resultListId}
Get allowed document links for a specific document.
Verb Accepts Produces
GET none DocumentLinks

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
resultListId : String
Result list for witch the document links will be retrieved. Ignored if null.

checkout

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/CheckOutToFileSystem
Checks out the document and returns the first section content
Verb Accepts Produces
POST CheckOutToFileSystemInfo */*

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

checkoutDocument

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/CheckoutDocument
Checks out the document and returns a download link for the first section.
Verb Accepts Produces
POST CheckOutToFileSystemInfo CheckOutResult

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

checkin

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/CheckInFromFileSystem
Check in document from the file system. You must specify a file format of XML or JSON for the parameters and the files with new content.
Verb Accepts Produces
POST multipart/form-data Document

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentAnnotations

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Annotation?cancellationToken={cancellationToken}
Gets or sets all annotations of the specified document.
Verb Accepts Produces
GET none DocumentAnnotations
POST DocumentAnnotationsPlacement DocumentAnnotations

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
cancellationToken : CancellationToken

documentThumbnail

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Thumbnail?size={size}&annotations={annotations}
Renders the thumbnail of the first page of the document and gets the image.
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
size (optional) : String
The size of the canvas of the rendered image. You can specify either a single integer like 200 or a pair of integers like 200x300. A single integer is interpreted as a square canvas.
annotations (optional) : Boolean
Specifies if the image contains annotations or not. If this parameter is missing the image contains all rendered annotation layers.

textshotPreview

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TextshotPreview?fullTextQuery={fullTextQuery}
Textshot preview of the document
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
fullTextQuery : String
Search term for fulltext search

documentImage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Image
Renders the image of the first page of the document and gets the image.
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

documentAnnotationAsImage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/AnnotationAsImage?format={format}&flags={flags}
Gets the annotation of the first section and first page as XAML or SVG. SVG images have a resolution of 72 dpi, XAML images have a resolution of 96 ppi.
Verb Accepts Produces
GET none image/svg+xmlapplication/xaml+xml

Parameters:

Name Description
id : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.
format : XmlImageFormat
flags (optional) : XmlImageCreationFlags, XmlImageCreationFlags, ...

workflowHistory

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{Id}/WorkflowHistory?cancellationToken={cancellationToken}
Verb Accepts Produces
GET none WorkflowDocumentHistory

Parameters:

Name Description
fileCabinetId : String
Id : Int32
cancellationToken (optional) : CancellationToken

documentAuditInformation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentAuditInformation?fromDate={fromDate}&toDate={toDate}&format={format}&start={start}&count={count}&fcName={fcName}&delimiter={delimiter}&isUtc={isUtc}
Verb Accepts Produces
GET none DocumentAuditInformation

Parameters:

Name Description
fileCabinetId : String
id : Int32
fromDate (optional) : DateTime
toDate (optional) : DateTime
format (optional) : String
The format of the result list. Currently only the value feed is supported.
start (optional, 0) : Int32
count (optional, 50) : Int32
fcName (optional, ) : String
delimiter (optional, ) : String
Separator for CSV segments.
isUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.

fileCabinet

/DocuWare/Platform/FileCabinets/{fileCabinetId}
Gets the representation of a file cabinet.
Verb Accepts Produces
GET none FileCabinet

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

fileCabinets

/DocuWare/Platform/FileCabinets
Verb Accepts Produces
GET none FileCabinets

auditEventProperties

/DocuWare/Platform/FileCabinets/{fileCabinetId}/FileCabinets/AuditEventProperties?eventId={eventId}
Verb Accepts Produces
GET none DocumentAuditEventInformation

Parameters:

Name Description
fileCabinetId : String
eventId : String

countResult

/DocuWare/Search/FileCabinets/{fileCabinetId}/Documents/CountExpression?dialogId={dialogId}&fieldName={fieldName}&limit={limit}
Counts the number of hits of a dialog query.
Verb Accepts Produces
GET none CountResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
dialogId : String
The identifier of the used dialog.
fieldName (optional) : String
The name of field whose values are counted. If this parameter is missing then only the number of entries of the dialog's result list is returned.
limit (optional) : Int32

selectListExpression

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/SelectListExpression?dialogId={dialogId}&fieldName={fieldName}&prefix={prefix}&q={q}&sortDirection={sortDirection}&start={start}&count={count}&typed={typed}&parentFieldName={parentFieldName}
Gets select list values for a dialog field with an optional prefix.
Verb Accepts Produces
GET none SelectListResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
dialogId : String
The identifier of the used dialog.
fieldName : String
The name of the field for which the select list values are retrieved.
prefix (optional) : String
The prefix of the returned select list values.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
sortDirection (optional) : SortDirection
Define sort order of the select list
start (optional) : Int32
First result to return if block size is specified
count (optional) : Int32
Result will be returned on pages with that block size if specified. If set to default (0) select lists will be returnen in one block using Limit parameter.
typed (optional) : Boolean
Define if select list will be returned as typed value
parentFieldName : String
The name of the parent table field for which the select list values are retrieved.

fieldValueStatistics

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/FieldValueStatistics
Gets grouped field values for a file cabinet field with dependencies to other fields and statistics (count of each value).
Verb Accepts Produces
POST SelectListExpression FieldValueStatisticsResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.

dialogExpression

/DocuWare/Search/FileCabinets/{fileCabinetId}/Documents/DialogExpression?dialogId={dialogId}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}
Executes a dialog expression and returns the result of the query.
Verb Accepts Produces
POST DialogExpression DocumentsQueryResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
dialogId : String
The identifier of the used dialog.
fields (optional) : String, String, ...
A list of user index field names which will appear in addition to the result list fields.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.

functionExpression

/DocuWare/Search/FileCabinets/{fileCabinetId}/Documents/functionExpression?fields={fields}&sortOrder={sortOrder}&start={start}&count={count}
Executes a function expression and returns the result of the query.
Verb Accepts Produces
GET none DocumentsQueryTableResult
POST FunctionExpressionQuery DocumentsQueryTableResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
fields (optional) : String, String, ...
A list of user index field names which will appear in addition to the result list fields.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.

notifications

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/Notifications?timeout={timeout}&notification={notification}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
timeout (optional) : Int32
notification (optional) : String, String, ...

queryDocuments

/DocuWare/Search/FileCabinets/{fileCabinetId}/Documents/QueryDocuments?q={q}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}&format={format}&additionalCabinets={additionalCabinets}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}&includeSuggestions={includeSuggestions}
Executes a custom expression and returns the result of the query.
Verb Accepts Produces
GET none DocumentsQueryResult
POST ResultListQuery DocumentLinkExpressionQuery DocumentsQueryResult

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
q (optional) : String
Queries the file cabinet for a list of documents. The documents are returned in pages of the specified size.
fields (optional) : String, String, ...
A list of user index field names which appear in the result.
sortOrder (optional) : String, String, ...
A list of fields to sort by. Each field name can have Asc or Desc appended in order to describe the sort order.
start (optional) : Int32
The number of records to be skipped, that is, the result list does not contain the first start records.
count (optional) : Int32
The maximum number of items per result page. The server returns at most count items per page. The actual number of items returned can be smaller.
format (optional) : String
The format of the result list. Currently only the value feed is supported.
additionalCabinets (optional) : String
Gets the additional cabinets to search in
encodingName (optional) : String
Encoding to be used for csv export.
csvDelimiter (optional, ) : String
Separator for CSV segments.
csvIsUtc (optional, True) : Boolean
A boolean value indicating whether date time in csv should be in UTC or local time.
includeSuggestions (optional, False) : Boolean
A value indicating whether Intellix suggetstions to be included.
calculateTotalCount (optional, True) : Boolean
A value indicating whether the total count of the documents should be calculated.

stampsByFileCabinet

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps?stampType={stampType}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
stampType (optional) : StampType, StampType, ...

stampSimpleSelectList

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/SimpleSelectList?stampFieldName={stampFieldName}&prefix={prefix}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : String
stampFieldName : String
prefix : String

stampAsImage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/AsImage?dpi={dpi}&xmlImageFormat={xmlImageFormat}
Verb Accepts Produces
GET none none
POST none none

Parameters:

Name Description
fileCabinetId : String
The identifier of the used file cabinet.
id : String
dpi (optional) : Int32
xmlImageFormat (optional) : XmlImageFormat

deepZoom

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Pages/{page}/{param}/dz.dzi
Gets the Deep Zoom Image description.
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
param : String
Rendering parameter. Currently the values 'wa' (with annotations) and 'woa' (without annotations) are supported, which specifiy if the images are rendered with or without annotations.

pageThumbnail

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Thumbnail?page={page}&size={size}&annotations={annotations}
Renders the specified thumbnail and gets the image.
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : String
The identifier of the section.
page : Int32
The number of the page to process.
fileCabinetId : String
The identifier of the used file cabinet.
size (optional) : String
The size of the canvas of the rendered image. You can specify either a single integer like 200 or a pair of integers like 200x300. A single integer is interpreted as a square canvas.
annotations (optional) : Boolean
Specifies if the image contains annotations or not. If this parameter is missing the image contains all rendered annotation layers.

pageImage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Image?page={page}&format={format}&size={size}&annotations={annotations}&quality={quality}&inverted={inverted}
Gets a rendered image of the specified page.
Verb Accepts Produces
GET none none

Parameters:

Name Description
id : String
The identifier of the section.
page : Int32
The number of the page to process.
fileCabinetId : String
The identifier of the used file cabinet.
format (optional) : PlatformImageFormat
The format of the rendered image.
size (optional) : String
The size of the canvas of the rendered image. You can specify either a single integer like 200 or a pair of integers like 200x300. A single integer is interpreted as a square canvas.
annotations (optional) : Boolean
Specifies if the image contains annotations or not. If this parameter is missing the image contains all rendered annotation layers.
quality (optional) : ImageQuality
Specifies the quality of the rendered image. If this parameter is not specified the image is rendered with low quality.
inverted (optional) : Boolean
Renders the image with inverted colors.

section

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}?embedThumbnailData={embedThumbnailData}&thumbnailSize={thumbnailSize}
Gets the specified section.
Verb Accepts Produces
GET none Section

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
embedThumbnailData (optional) : Boolean
thumbnailSize : String

sections

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections?docid={docid}
Gets all sections of the specified document.
Verb Accepts Produces
GET none Sections

Parameters:

Name Description
docid : Int32
The identifier of the document.
fileCabinetId : String
The identifier of the used file cabinet.

pagesBlock

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/PagesBlock?start={start}&count={count}&embedThumbnailData={embedThumbnailData}&thumbnailSize={thumbnailSize}&thumbnailsOnly={thumbnailsOnly}
Gets the pages of the specified section. Pages are retrived in blocks of a specified size. Each block links to the next block of pages. A client should follow these links.
Read more...
Verb Accepts Produces
GET none Pages

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
start (optional) : Int32
count (optional) : Int32
embedThumbnailData (optional) : Boolean
thumbnailSize (optional) : String
The size of the canvas of the rendered image. You can specify either a single integer like 200 or a pair of integers like 200x300. A single integer is interpreted as a square canvas.
thumbnailsOnly (optional, False) : Boolean
If set to True get only basic page data to show thumbnails

sectionPagesBlockResult

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/PagesBlockResult
Gets the pages of the specified section. Pages are retrived in blocks of a specified size. Each block links to the next block of pages. A client should follow these links.
Verb Accepts Produces
POST PagesBlockQuery Pages

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.

sectionPage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Page?page={page}
Gets the represenation of the specified page.
Verb Accepts Produces
GET none Page

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.

sectionData

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Data?documentInfoInFileName={documentInfoInFileName}
Download or upload section file.
Verb Accepts Produces
GET none */*

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
documentInfoInFileName (optional) : Boolean
Specifies whether the name of the downloaded file contains encoded document info

sectionTextshot

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Textshot
Adds or changes the textshot of a section.
Verb Accepts Produces
PUT none text/plain
POST none text/plain

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.

sectionTextshotPage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextshotPage?page={page}&flat={flat}&normalize={normalize}
Gets the textshot of a page.
Verb Accepts Produces
GET none PageContent

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
flat (optional, False) : Boolean
If this parameter is true then the textshot is flattened to a single text box which contains all the lines of the page. Also all spaces are replaced by words containing a single space character as content. You should specifiy this parameter if you want a simple representation of all lines and words of a page rather than the complex page layout.
normalize (optional, False) : Boolean
If this parameter is true then the textshot rotation is alligned with rendition orientation.

annotation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Annotation?page={page}&cancellationToken={cancellationToken}
Gets the annotation of the specified page.
Verb Accepts Produces
GET none Annotation
PUT Annotation AnnotationsPlacement Annotation
POST Annotation AnnotationsPlacement Annotation

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
cancellationToken : CancellationToken

sectionStamp

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Stamp?page={page}&cancellationToken={cancellationToken}
Places a stamp at the specified page and returns the modified annotation.
Verb Accepts Produces
POST StampPlacement Annotation

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
cancellationToken : CancellationToken

pageAnnotationsAsImage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/AnnotationAsImage?page={page}&format={format}&flags={flags}
Gets the annotation of the specified page as XAML or SVG. SVG images have a resolution of 72 dpi, XAML images have a resolution of 96 ppi.
Verb Accepts Produces
GET none image/svg+xmlapplication/xaml+xml

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
format : XmlImageFormat
flags (optional) : XmlImageCreationFlags, XmlImageCreationFlags, ...

sectionPositions

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Positions?q={q}&wholeWord={wholeWord}&ignoreCase={ignoreCase}&startSectionNumber={startSectionNumber}&startPage={startPage}&pageCount={pageCount}&rangeSearch={rangeSearch}&backward={backward}
Gets the positions of a word within the specified section.
Verb Accepts Produces
GET none WordSearchResult

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
q : String
Specifies the search phrase (words)
wholeWord (optional) : Boolean
Specifies whether to search for whole words. If this is set to true then only whe words are search instead od the phrase.
ignoreCase (optional) : Boolean
Specifies if the search is case insensitive.
startSectionNumber (optional) : Int32
Specifies the first section which is searched.
startPage (optional) : Int32
Specifies the first page which is searched.
pageCount (optional) : Int32
Specifies a number number of pages after the first page where a hit occur. If value is less than zero then all pages will be returned
rangeSearch (optional) : Boolean
If this flag is true then only the specified page range is searched. Otherwise the whole document starting at the specified page is searched until the specified number of pages are found.
backward (optional) : Boolean
If this flag is true then only the specified page range is searched. Otherwise the whole document starting at the specified page is serched until the specified number of pages are found.

sectionFileDownload

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/FileDownload?targetFileType={targetFileType}&keepAnnotations={keepAnnotations}&downloadFile={downloadFile}&autoPrint={autoPrint}&sendByEmail={sendByEmail}&layers={layers}
Gets the section file data in the specified format.
Verb Accepts Produces
GET none */*

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
targetFileType (optional) : FileDownloadType
keepAnnotations (optional) : Boolean
downloadFile (optional) : Boolean
autoPrint (optional) : Boolean
sendByEmail (optional) : Boolean
layers (optional) : Int32, Int32, ...

sectionFileDownloadPage

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/FileDownloadPage?page={page}&keepAnnotations={keepAnnotations}&downloadFile={downloadFile}&autoPrint={autoPrint}&sendByEmail={sendByEmail}&layers={layers}
Downloads the specified page from the section file as single page PDF file.
Verb Accepts Produces
GET none application/pdf

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.
keepAnnotations (optional) : Boolean
downloadFile (optional) : Boolean
autoPrint (optional) : Boolean
sendByEmail (optional) : Boolean
layers (optional) : Int32, Int32, ...

sectionTextAnnotation

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextAnnotation?ignoreMe={ignoreMe}
Get section's text annotation.
Verb Accepts Produces
GET none text/plain

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
ignoreMe (optional, False) : Boolean

sectionStampBestPosition

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/StampBestPosition?page={page}
Gets the stamps' best location.
Verb Accepts Produces
POST StampFormFieldValues DWPoint

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.
page : Int32
The number of the page to process.

sectionApplicationProperties

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/SectionApplicationProperties
Provide functionality for custom application properties for a document.
Verb Accepts Produces
GET none DocumentApplicationProperties
POST DocumentApplicationProperties DocumentApplicationProperties

Parameters:

Name Description
id : String
The identifier of the section.
fileCabinetId : String
The identifier of the used file cabinet.

signalRToken

/DocuWare/Platform/Home/SignalRToken
Gets a token which can be used to authenticate on the SignalR hub
Verb Accepts Produces
GET none text/plain

clientSetupData

/DocuWare/Platform/Home/ClientSetupInfo?orgId={orgId}&baseAddress={baseAddress}&clientSetupVersion={clientSetupVersion}
Verb Accepts Produces
GET none application/xml

Parameters:

Name Description
orgId : String
baseAddress (optional) : String
clientSetupVersion (optional) : String

organization

/DocuWare/Platform/Organization
Gets the full information of the specified organization.
Verb Accepts Produces
GET none Organization

dialogs

/DocuWare/Platform/Organization/Dialogs?dialogType={dialogType}
Gets all dialogs of the specified organizations.
Verb Accepts Produces
GET none DialogInfos

Parameters:

Name Description
dialogType (optional) : DialogTypes, DialogTypes, ...
The dialog types to retrieve. You can specify multiple dialog types as matrix parameter.

users

/DocuWare/Platform/Organization/Users?roleId={roleId}
Gets all users of the organization.
Verb Accepts Produces
GET none Users

Parameters:

Name Description
roleId : String

usersByGroup

/DocuWare/Platform/Organization/GroupUsers?groupId={groupId}
Gets all users of the organization.
Verb Accepts Produces
GET none Users

Parameters:

Name Description
groupId : String
The identifier of a group.

userById

/DocuWare/Platform/Organization/UserByID?userId={userId}
Verb Accepts Produces
GET none User

Parameters:

Name Description
userId : String

userRoles

/DocuWare/Platform/Organization/UserRoles?userId={userId}
Verb Accepts Produces
GET none Roles

Parameters:

Name Description
userId : String

userGroups

/DocuWare/Platform/Organization/UserGroups?userId={userId}
Verb Accepts Produces
GET none Groups

Parameters:

Name Description
userId : String

userInfo

/DocuWare/Platform/Organization/UserInfo
Verb Accepts Produces
GET none UserInfo

validateUser

/DocuWare/Platform/Organization/ValidateUser
Verb Accepts Produces
POST UserValidation text/plain

roles

/DocuWare/Platform/Organization/Roles
Verb Accepts Produces
GET none Roles

role

/DocuWare/Platform/Organization/Role?roleId={roleId}
Verb Accepts Produces
GET none Role

Parameters:

Name Description
roleId : String

group

/DocuWare/Platform/Organization/Group?groupId={groupId}
Verb Accepts Produces
GET none Group

Parameters:

Name Description
groupId : String

groups

/DocuWare/Platform/Organization/Groups
Verb Accepts Produces
GET none Groups

selectList

/DocuWare/Platform/Organization/SelectList?selectListId={selectListId}
Verb Accepts Produces
GET none SelectListInfo

Parameters:

Name Description
selectListId : String

selectListValues

/DocuWare/Platform/Organization/SelectListValues?selectListId={selectListId}&start={start}&count={count}&prefix={prefix}&returnType={returnType}
Verb Accepts Produces
GET none SelectListValuesResult

Parameters:

Name Description
selectListId : String
start (optional) : Int32
First result to return if block size is specified
count (optional) : Int32
Result will be returned on pages with that block size if specified. If set to default (0) select lists will be returnen in one block using Limit parameter.
prefix (optional) : String
The prefix of the returned select list values.
returnType (optional) : String
Return type of the result. Possible values are "String", "Decimal", "Date" and "DateTime". If ommited, each value is converted to a string using the agent's locale settings.

singleColumnSelectListValuesResult

/DocuWare/Platform/Organization/SingleColumnSelectListValuesResult?selectListId={selectListId}&start={start}&count={count}&prefix={prefix}&returnType={returnType}
Verb Accepts Produces
GET none SingleColumnSelectListValues

Parameters:

Name Description
selectListId : String
start (optional) : Int32
First result to return if block size is specified
count (optional) : Int32
Result will be returned on pages with that block size if specified. If set to default (0) select lists will be returnen in one block using Limit parameter.
prefix (optional) : String
The prefix of the returned select list values.
returnType (optional) : String
Return type of the result. Possible values are "String", "Decimal", "Date" and "DateTime". If ommited, each value is converted to a string using the agent's locale settings.

selectListValues

/DocuWare/Platform/Organization/SelectListValues?selectListId={selectListId}
Verb Accepts Produces
POST SelectListValuesQuery SelectListValuesResult

Parameters:

Name Description
selectListId : String

areValuesInSelectList

/DocuWare/Platform/Organization/AreValuesInSelectList?selectListId={selectListId}
Verb Accepts Produces
POST SelectListValuesToCheck AreValuesInSelectListsResult

Parameters:

Name Description
selectListId : String

multiColSelectListValues

/DocuWare/Platform/Organization/MultiColSelectListValues?selectListId={selectListId}&start={start}&count={count}
Verb Accepts Produces
GET none MultiColSelectListValuesResult

Parameters:

Name Description
selectListId : String
start (optional) : Int32
First result to return if block size is specified
count (optional) : Int32
Result will be returned on pages with that block size if specified. If set to default (0) select lists will be returnen in one block using Limit parameter.

multiColSelectListValuesWithQuery

/DocuWare/Platform/Organization/MultiColSelectListValues?selectListId={selectListId}
Verb Accepts Produces
POST MultiColSelectListValuesQuery MultiColSelectListValuesResult

Parameters:

Name Description
selectListId : String

multiColumnSelectListValues

/DocuWare/Platform/Organization/MultiColumnSelectListValues?selectListId={selectListId}
Verb Accepts Produces
POST MultiColumnSelectListValuesQuery SelectListValuesResult

Parameters:

Name Description
selectListId : String

selectLists

/DocuWare/Platform/Organization/SelectLists
Verb Accepts Produces
GET none SelectListInfos

multiColSelectLists

/DocuWare/Platform/Organization/MultiColSelectLists
Verb Accepts Produces
GET none MultiColSelectListInfos

multiColSelectList

/DocuWare/Platform/Organization/MultiColSelectList?selectListId={selectListId}
Verb Accepts Produces
GET none MultiColSelectListInfo

Parameters:

Name Description
selectListId : String

webSettings

/DocuWare/Platform/Organization/WebSettings
Verb Accepts Produces
GET none WebSettings

loginToken

/DocuWare/Platform/Organization/LoginToken
Verb Accepts Produces
POST TokenDescription text/plain

substitutionLists

/DocuWare/Platform/Organization/SubstitutionLists
Verb Accepts Produces
GET none SubstitutionLists

substitutionRulesByGroup

/DocuWare/Platform/Organization/SubstitutionRules?subsListGuid={subsListGuid}
Verb Accepts Produces
GET none SubstitutionRules

Parameters:

Name Description
subsListGuid : String

storeIntegration

/DocuWare/Platform/WebClient/Client/Store?dlgID={dlgID}&fc={fc}&culture={culture}&validateMandatoryFields={validateMandatoryFields}&intgParams={intgParams}
Verb Accepts Produces
GET none none

Parameters:

Name Description
dlgID : String
fc : String
culture : String
validateMandatoryFields (optional, True) : Boolean
intgParams (optional) : String

indexesIntegration

/DocuWare/Platform/WebClient/Client/Indexes?rl={rl}&fc={fc}&did={did}&culture={culture}&intgParams={intgParams}
Verb Accepts Produces
GET none none

Parameters:

Name Description
rl : String
fc : String
did : Int32
culture : String
intgParams (optional) : String

storeIntegration

/DocuWare/Platform/WebClient/Settings/Store?dlgID={dlgID}&fc={fc}&culture={culture}&validateMandatoryFields={validateMandatoryFields}
Verb Accepts Produces
POST none none

Parameters:

Name Description
dlgID : String
fc : String
culture : String
validateMandatoryFields (optional, True) : Boolean

indexesIntegration

/DocuWare/Platform/WebClient/Settings/Indexes?rl={rl}&fc={fc}&did={did}&culture={culture}
Verb Accepts Produces
POST none none

Parameters:

Name Description
rl : String
fc : String
did : Int32
culture : String

stamps

/DocuWare/Platform/WebClient/Viewer/Stamps?fileCabinetId={fileCabinetId}&stampType={stampType}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
stampType (optional) : StampType, StampType, ...

validateStampFields

/DocuWare/Platform/WebClient/Viewer/ValidateStampFields?fileCabinetId={fileCabinetId}
Verb Accepts Produces
POST StampFormFieldValues none

Parameters:

Name Description
fileCabinetId : String

getDocument

/DocuWare/Platform/WebClient/Viewer/GetDocument?fileCabinetId={fileCabinetId}&docId={docId}&withContentArea={withContentArea}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
docId : Int32
withContentArea (optional, True) : Boolean

getSection

/DocuWare/Platform/WebClient/Viewer/GetSection?fileCabinetId={fileCabinetId}&docId={docId}&sectionId={sectionId}&page={page}&withContentArea={withContentArea}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
docId : Int32
sectionId : String
page : Int32
withContentArea (optional, True) : Boolean

getPage

/DocuWare/Platform/WebClient/Viewer/GetPage?fileCabinetId={fileCabinetId}&docId={docId}&sectionId={sectionId}&page={page}&withContentArea={withContentArea}
Verb Accepts Produces
GET none none

Parameters:

Name Description
fileCabinetId : String
docId : Int32
sectionId : String
page : Int32
withContentArea (optional, True) : Boolean