Platform Service URL Reference

This page lists all URL templates of the DocuWare Platform Service. Parameters inside a template can be replaced by values. The type of the values can be inspected when you click at a URL template.

/DocuWare/Platform/Account/ChangePassword

Invocations:

GET

/DocuWare/Platform/Account/ChangePassword?model={model}

Invocations:

POST

Parameters:

model : ChangePasswordModel

/DocuWare/Platform/Account/ChangePasswordSuccess

Invocations:

GET

/DocuWare/Platform/Account/CredentialValidation?model={model}

Invocations:

POST
Produces:: text/plain

Parameters:

model : LogOnModel

/DocuWare/Platform/Account/Disconnect?returnUrl={returnUrl}

Invocations:

GET

Parameters:

returnUrl : String

/DocuWare/Platform/Account/GetAuthentication

Invocations:

GET
Produces:: text/plain

/DocuWare/Platform/Account/IdServiceEntry?returnUrl={returnUrl}

Invocations:

GET

Parameters:

returnUrl : String

/DocuWare/Platform/Account/JwtLogOn?accessToken={accessToken}&licenseType={licenseType}

Invocations:

POST

Parameters:

accessToken : String
licenseType (optional) : DWProductTypes

/DocuWare/Platform/Account/LogOff?returnUrl={returnUrl}

Invocations:

GET

Parameters:

returnUrl : String

/DocuWare/Platform/Account/LogOn?model={model}

Invocations:

POST

Parameters:

model : LogOnModel

/DocuWare/Platform/Account/LogOnGuest?returnUrl={returnUrl}

Invocations:

GET

Parameters:

returnUrl : String

/DocuWare/Platform/Account/LogOnGuest?model={model}

Invocations:

POST

Parameters:

model : LogOnWithIdentityModel

/DocuWare/Platform/Account/LogOnNTLM?redirect={redirect}

Invocations:

GET

Parameters:

redirect : String

/DocuWare/Platform/Account/LogOnNTLM?model={model}

Invocations:

POST

Parameters:

model : LogOnWithIdentityModel

/DocuWare/Platform/Account/PermanentUrl?clientSideChecksum={clientSideChecksum}

Enriches the specified URL with an encrypted identity.

Invocations:

POST
Accepts:: application/x-www-form-urlencoded
Produces:: text/plain

Parameters:

clientSideChecksum (optional, False) : Boolean

/DocuWare/Platform/Account/PermanentUrl?url={url}&ignoreMe={ignoreMe}&clientSideChecksum={clientSideChecksum}

Invocations:

GET

Parameters:

url : String
ignoreMe (optional) : String
clientSideChecksum (optional, False) : Boolean

/DocuWare/Platform/Account/Register

Invocations:

GET

/DocuWare/Platform/Account/Register?model={model}

Invocations:

POST

Parameters:

model : CreateUserModel

/DocuWare/Platform/Account/ResetPassword

Invocations:

GET

/DocuWare/Platform/Account/ResetPassword?model={model}

Invocations:

POST

Parameters:

model : ResetPasswordModel

/DocuWare/Platform/Account/ResetPasswordSuccess

Invocations:

GET

/DocuWare/Platform/Account/TestUser

Invocations:

GET

/DocuWare/Platform/Account/TokenChangePassword?token={token}

Invocations:

GET

Parameters:

token : String

/DocuWare/Platform/Account/TokenChangePassword?model={model}

Invocations:

POST

Parameters:

model : TokenChangePasswordModel

/DocuWare/Platform/Account/TokenLogOn?token={token}&returnUrl={returnUrl}&rememberMe={rememberMe}&licenseType={licenseType}

Invocations:

GET

Parameters:

token : String
returnUrl : String
rememberMe (optional) : Boolean
licenseType (optional) : DWProductTypes: A specified DocuWare license is blocked with this login.

/DocuWare/Platform/Account/TokenLogOn?model={model}&returnUrl={returnUrl}

Invocations:

POST

Parameters:

model : TokenLogOnModel
returnUrl : String

/DocuWare/Platform/Account/TrustedLogOn?model={model}

Invocations:

POST

Parameters:

model : TrustedLogOnModel

/DocuWare/Platform/Browser

Invocations:

GET

PUT

POST

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}?ignoreErrors={ignoreErrors}

Invocations:

GET
Produces:: Decision

Parameters:

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

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/Confirm

Invocations:

POST
Accepts:: ConfirmedData

Parameters:

workflowId : String
instanceId : String
taskId : String
decisionId : Int32

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampBestPosition

Invocations:

POST
Accepts:: StampPositionData
Produces:: DWPoint

Parameters:

workflowId : String
instanceId : String
taskId : String
decisionId : Int32

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Decisions/{decisionId}/StampDecisions?ignoreErrors={ignoreErrors}

Invocations:

GET
Produces:: Decision

Parameters:

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

/DocuWare/Platform/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/Reassign

Invocations:

POST
Accepts:: ReassignmentData

Parameters:

workflowId : String
instanceId : String
taskId : String

/DocuWare/Platform/DeepZoom?uri={uri}

Displays a deep zoom image.

Invocations:

GET
Produces:: text/html

Parameters:

uri : String: The URI of the image to display.

/DocuWare/Platform/FileCabinets

Invocations:

GET
Produces:: FileCabinets

/DocuWare/Platform/FileCabinets/{fileCabinetId}

Gets the representation of a file cabinet.

Invocations:

GET
Produces:: FileCabinet

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/ArchiveDocument?id={id}

Invocations:

POST
Accepts:: ExportSettings
Produces:: */*

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/ImportDocument

Invocations:

POST
Accepts:: */*
Produces:: ImportResult

Parameters:

fileCabinetId : String

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Archiving/Index?q={q}&fields={fields}&sortOrder={sortOrder}

Invocations:

POST
Accepts:: ExportSettings
Produces:: */*

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs?dialogType={dialogType}

Gets dialogs.

Invocations:

GET
Produces:: DialogInfos

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}?dialogType={dialogType}

Gets the full representation of a dialog.

Invocations:

GET
Produces:: Dialog

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}

Modifies the specified dialog (only for private task lists)

Invocations:

POST
Accepts:: UserDefinedSearchModifyInfo
Produces:: Dialog

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}

Deletes the specified dialog (only for private task lists)

Invocations:

DELETE
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/BatchUpdateFields?fields={fields}&sortOrder={sortOrder}

Process update index fields in batch defined by a dialog expression

Invocations:

POST
Accepts:: BatchUpdateProcess
Produces:: BatchUpdateIndexFieldsResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/CreateUserDefinedSearch

Creates a user defined search based on result list

Invocations:

POST
Accepts:: UserDefinedSearchInfo
Produces:: Dialog

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Dialogs/{id}/Validate

Perform client side validation defined in the specified dialog.

Invocations:

POST
Accepts:: DocumentIndexFields

Parameters:

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

/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.

Invocations:

GET
Produces:: DocumentsQueryResult; application/atom+xml

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents?processTextshot={processTextshot}&imageProcessing={imageProcessing}&redirect={redirect}&storeDialogId={storeDialogId}&checkFileNameForCheckinInfo={checkFileNameForCheckinInfo}

Adds a new document to the file cabinet.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}

Deletes the specified document.

Invocations:

DELETE
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}

Gets the meta data of the specified document.

Invocations:

GET
Produces:: Document

Parameters:

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

/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.

Invocations:

POST
Accepts:: multipart/form-data
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Annotation?cancellationToken={cancellationToken}

Gets or sets all annotations of the specified document.

Invocations:

GET
Produces:: DocumentAnnotations

POST
Accepts:: DocumentAnnotationsPlacement
Produces:: DocumentAnnotations

Parameters:

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

/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.

Invocations:

GET
Produces:: image/svg+xml; application/xaml+xml

Parameters:

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

/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.

Invocations:

POST
Accepts:: multipart/form-data
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/CheckoutDocument

Checks out the document and returns a download link for the first section.

Invocations:

POST
Accepts:: CheckOutToFileSystemInfo
Produces:: CheckOutResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/CheckOutToFileSystem

Checks out the document and returns the first section content

Invocations:

POST
Accepts:: CheckOutToFileSystemInfo
Produces:: */*

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/ChecksumStatus

Get a document's checksum status.

Invocations:

GET
Produces:: ChecksumStatusType

Parameters:

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

/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.

Invocations:

GET
Produces:: */*

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Data

Retrieve multiple documents content data of the document. If there is only one section it contain the section file otherwhise zip with all section files.

Invocations:

POST
Accepts:: IntegerList
Produces:: */*

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentApplicationProperties

Provide functionality for custom application properties for a document.

Invocations:

GET
Produces:: DocumentApplicationProperties

POST
Accepts:: DocumentApplicationProperties
Produces:: DocumentApplicationProperties

Parameters:

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

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

Invocations:

GET
Produces:: DocumentAuditInformation

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentAuditInformation

Invocations:

POST
Produces:: DocumentAuditInformation

Parameters:

fileCabinetId : String
id : Int32

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/DocumentLinks?resultListId={resultListId}

Get allowed document links for a specific document.

Invocations:

GET
Produces:: DocumentLinks

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Fields

Retrieve or update document fields.

Invocations:

GET
Produces:: DocumentIndexFields

PUT
Accepts:: DocumentIndexFields; UpdateIndexFieldsInfo
Produces:: DocumentIndexFields

POST
Accepts:: DocumentIndexFields; UpdateIndexFieldsInfo
Produces:: DocumentIndexFields

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/FileDownload

Download customized document file

Invocations:

POST
Accepts:: FileDownload
Produces:: */*

Parameters:

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

/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

Invocations:

GET
Produces:: */*

Parameters:

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, ...

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Image

Renders the image of the first page of the document and gets the image.

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/LatestVersion

Gets the meta data of the latest version of a document.

Invocations:

GET
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Lock

Creates or removes a lock of a document.

Invocations:

POST
Accepts:: LockInfo
Produces:: text/plain

DELETE
Accepts:: LockInfo
Produces:: text/plain

Parameters:

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

/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

Invocations:

GET
Produces:: DocumentWordSearchResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Positions

Retrieve word positions of a phrase

Invocations:

POST
Accepts:: SearchPositionQuery
Produces:: DocumentWordSearchResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Rights

Checks if specific rights are valid for a document and retrieves them.

Invocations:

POST
Accepts:: Rights
Produces:: Rights

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/Suggestions?normalizeCoordinates={normalizeCoordinates}

Retrieve simple field suggestions by the Intelligent Indexing Services.

Invocations:

GET
Produces:: SuggestionFields

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TableFieldRows?tableFieldName={tableFieldName}&start={start}&count={count}

Retrieve the value of specific table field of a document.

Invocations:

GET
Produces:: DocumentIndexFieldTable

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TableFieldsSuggestions?normalizeCoordinates={normalizeCoordinates}

Retrieve table field suggestions by the Intelligent Indexing Services.

Invocations:

GET
Produces:: SuggestionTableFields

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TextAnnotation?ignoreMe={ignoreMe}

Get document's text annotation.

Invocations:

GET
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TextAnnotation

Changes a document's text annotation.

Invocations:

POST
Accepts:: String
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/TextshotPreview?fullTextQuery={fullTextQuery}

Textshot preview of the document

Invocations:

GET

Parameters:

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

/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.

Invocations:

GET

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{Id}/WorkflowHistory?cancellationToken={cancellationToken}

Invocations:

GET
Produces:: WorkflowDocumentHistory

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/{id}/XmlDSigContent?verify={verify}

Get document XML Digital signatures content

Invocations:

GET
Produces:: XmlDSigContentType

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Documents/ExecuteAuditQueryAsync?auditQuery={auditQuery}&format={format}&csvExpression={csvExpression}&fcName={fcName}

Invocations:

GET

PUT

POST

Parameters:

fileCabinetId : String
auditQuery : DocumentAuditQuery
format : String
csvExpression : CsvExpression
fcName : String

/DocuWare/Platform/FileCabinets/{fileCabinetId}/FileCabinets/AuditEventProperties?eventId={eventId}

Invocations:

GET
Produces:: DocumentAuditEventInformation

Parameters:

fileCabinetId : String
eventId : String

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/BatchDocumentsUpdateFields

Process update index fields in batch defined by a list of documents.

Invocations:

POST
Accepts:: BatchUpdateProcess; BatchAppendKeywordValues
Produces:: BatchUpdateIndexFieldsResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/BatchQueryUpdateFields?fields={fields}&sortOrder={sortOrder}&q={q}&start={start}

Process update index fields in batch defined by a query.

Invocations:

POST
Accepts:: BatchUpdateProcessData
Produces:: BatchUpdateIndexFieldsResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ClippedDocuments?docId={docId}&operation={operation}

Invocations:

POST
Accepts:: IntegerList
Produces:: Document

PUT
Accepts:: IntegerList
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ContentDivide?docId={docId}

Invocations:

POST
Accepts:: ContentDivideOperationInfo
Produces:: DocumentsQueryResult

PUT
Accepts:: ContentDivideOperationInfo
Produces:: DocumentsQueryResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ContentMerge

Invocations:

POST
Accepts:: ContentMergeOperationInfo
Produces:: Document

PUT
Accepts:: ContentMergeOperationInfo
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/CreateUserDefinedSearch?q={q}

Creates a user defined search based on result list

Invocations:

POST
Accepts:: UserDefinedSearchInfo
Produces:: Dialog

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/ProcessDocumentAction?docId={docId}

Perform specific action on document

Invocations:

PUT
Accepts:: DocumentActionInfo
Produces:: Document

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Operations/RetrieveSequenceElement

Invocations:

POST
Accepts:: SequenceRequest
Produces:: SequenceResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/CountExpression?dialogId={dialogId}

Counts the number of hits of a dialog query.

Invocations:

POST
Accepts:: CountExpression
Produces:: CountResult

Parameters:

fileCabinetId : String: The identifier of the used file cabinet.
dialogId : String: The identifier of the used dialog.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/CountExpression?dialogId={dialogId}&fieldName={fieldName}&limit={limit}

Counts the number of hits of a dialog query.

Invocations:

GET
Produces:: CountResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/DialogExpression?dialogId={dialogId}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}

Executes a dialog expression and returns the result of the query.

Invocations:

POST
Accepts:: DialogExpression
Produces:: DocumentsQueryResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/DialogExpression?dialogId={dialogId}&fields={fields}&sortOrder={sortOrder}

Invocations:

GET

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/DialogExpressionLink?dialogId={dialogId}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}

Invocations:

POST
Accepts:: DialogExpression
Produces:: DocumentsQueryResult

Parameters:

fileCabinetId : String: The identifier of the used file cabinet.
dialogId : String
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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/Documents?q={q}&fields={fields}&sortOrder={sortOrder}&start={start}&count={count}&format={format}&additionalCabinets={additionalCabinets}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}&includeSuggestions={includeSuggestions}&calculateTotalCount={calculateTotalCount}

Executes a custom expression and returns the result of the query.

Invocations:

GET
Produces:: DocumentsQueryResult

POST
Accepts:: ResultListQuery; DocumentLinkExpressionQuery
Produces:: DocumentsQueryResult

Parameters:

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.

/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).

Invocations:

POST
Accepts:: SelectListExpression
Produces:: FieldValueStatisticsResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/FunctionExpression?fields={fields}&sortOrder={sortOrder}&start={start}&count={count}

Executes a function expression and returns the result of the query.

Invocations:

GET
Produces:: DocumentsQueryTableResult

POST
Accepts:: FunctionExpressionQuery
Produces:: DocumentsQueryTableResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/Notifications?timeout={timeout}&notification={notification}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/OpenSearchDescription

Invocations:

GET

PUT

POST

Parameters:

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

/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.

Invocations:

GET
Produces:: SelectListResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Query/SelectListExpression?dialogId={dialogId}&fieldName={fieldName}&parentFieldName={parentFieldName}

Gets select list values for a dialog field with dependencies to other fields.

Invocations:

POST
Accepts:: SelectListExpression; FileCabinetSelectListExpression
Produces:: SelectListResult

Parameters:

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.
parentFieldName : String: The name of the parent table field for which the select list values are retrieved.

/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.

Invocations:

GET

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Pages/{page}/{param}/dz.dzi

Gets the Deep Zoom Image description.

Invocations:

GET

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Pages/{page}/{param}/dz_files/{level}/{column}_{row}.{ext}?inverted={inverted}

Renders the specified Deep Zoom tile.

Invocations:

GET

Parameters:

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.
level : Int32
column : Int32
row : Int32
ext : String: The file extension, either jpeg or png.
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.
inverted (optional) : Boolean: Renders the image with inverted colors.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Rendering/{id}/Thumbnail?page={page}&size={size}&annotations={annotations}

Renders the specified thumbnail and gets the image.

Invocations:

GET

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationCabinetInfo

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationData

Invocations:

POST

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationData?additionalFields={additionalFields}&startAfterDocGuid={startAfterDocGuid}&pageSize={pageSize}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/ReplicationDeleteData

Invocations:

POST

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Replication/SetupReplication

Invocations:

POST

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections?docid={docid}&fileName={fileName}

Appends a new section to the specified document.

Invocations:

POST
Accepts:: */*
Produces:: Section

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections?docid={docid}

Gets all sections of the specified document.

Invocations:

GET
Produces:: Sections

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}?embedThumbnailData={embedThumbnailData}&thumbnailSize={thumbnailSize}

Gets the specified section.

Invocations:

GET
Produces:: Section

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}

Deletes a section by id.

Invocations:

DELETE
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Annotation?page={page}&cancellationToken={cancellationToken}

Gets the annotation of the specified page.

Invocations:

GET
Produces:: Annotation

PUT
Accepts:: Annotation; AnnotationsPlacement
Produces:: Annotation

POST
Accepts:: Annotation; AnnotationsPlacement
Produces:: Annotation

Parameters:

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

/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.

Invocations:

GET
Produces:: image/svg+xml; application/xaml+xml

Parameters:

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, ...

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Data?documentInfoInFileName={documentInfoInFileName}

Download or upload section file.

Invocations:

GET
Produces:: */*

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Data?fileName={fileName}

Download or upload section file.

Invocations:

PUT
Accepts:: */*
Produces:: Section

POST
Accepts:: */*
Produces:: Section

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/FileDownload

Gets the section file data in the specified format.

Invocations:

POST
Produces:: */*

Parameters:

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

/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.

Invocations:

GET
Produces:: */*

Parameters:

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, ...

/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.

Invocations:

GET
Produces:: application/pdf

Parameters:

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, ...

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/FileDownloadPage?page={page}

Downloads the specified page from the section file as single page PDF file.

Invocations:

POST
Produces:: application/pdf

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Page?page={page}

Gets the represenation of the specified page.

Invocations:

GET
Produces:: Page

Parameters:

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.

/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.

/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.

Invocations:

POST
Accepts:: PagesBlockQuery
Produces:: Pages

Parameters:

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

/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.

Invocations:

GET
Produces:: WordSearchResult

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Positions

Gets the positions of a word within the specified section.

Invocations:

POST
Accepts:: SearchPositionQuery
Produces:: WordSearchResult

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/SectionApplicationProperties

Provide functionality for custom application properties for a document.

Invocations:

GET
Produces:: DocumentApplicationProperties

POST
Accepts:: DocumentApplicationProperties
Produces:: DocumentApplicationProperties

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Stamp?page={page}&cancellationToken={cancellationToken}

Places a stamp at the specified page and returns the modified annotation.

Invocations:

POST
Accepts:: StampPlacement
Produces:: Annotation

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/StampBestPosition?page={page}

Gets the stamps' best location.

Invocations:

POST
Accepts:: StampFormFieldValues
Produces:: DWPoint

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextAnnotation?ignoreMe={ignoreMe}

Get section's text annotation.

Invocations:

GET
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextAnnotation

Changes a section's text annotation.

Invocations:

POST
Accepts:: String
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Textshot

Adds or changes the textshot of a section.

Invocations:

PUT
Produces:: text/plain

POST
Produces:: text/plain

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/Textshot?ignoreMe={ignoreMe}

Gets the textshot of a section.

Invocations:

GET
Produces:: DocumentContent

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextshotPage?page={page}&flat={flat}&normalize={normalize}

Gets the textshot of a page.

Invocations:

GET
Produces:: PageContent

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextshotPage?page={page}

Adds or changes the textshot of a page.

Invocations:

PUT
Accepts:: PageContent
Produces:: text/plain

POST
Accepts:: PageContent
Produces:: text/plain

Parameters:

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.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Sections/{id}/TextshotXslt?page={page}

Invocations:

GET

Parameters:

id : String: The identifier of the section.
fileCabinetId : String: The identifier of the used file cabinet.
page (optional) : Int32: The number of the page to process.

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps?stampType={stampType}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/AsImage?dpi={dpi}&xmlImageFormat={xmlImageFormat}

Invocations:

GET

POST

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/AsImageForm?xmlImageFormat={xmlImageFormat}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/SimpleSelectList?stampFieldName={stampFieldName}&prefix={prefix}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Stamps/{id}/SimpleSelectList?stampFieldName={stampFieldName}

Invocations:

POST

Parameters:

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

/DocuWare/Platform/FileCabinets/{fileCabinetId}/Task/Transfer?storeDialogId={storeDialogId}

Invocations:

POST
Accepts:: FileCabinetTransferInfo; DocumentsTransferInfo
Produces:: DocumentsQueryResult

Parameters:

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

/DocuWare/Platform/HealthCheck

Invocations:

GET

/DocuWare/Platform/HealthCheck/Warmup

Invocations:

GET

PUT

POST

/DocuWare/Platform/Home/About

Invocations:

GET

/DocuWare/Platform/Home/CFS

Invocations:

POST
Accepts:: CFSStatisticGeneral
Produces:: text/plain

/DocuWare/Platform/Home/ClientSetupInfo?orgId={orgId}&baseAddress={baseAddress}&clientSetupVersion={clientSetupVersion}

Invocations:

GET
Produces:: application/xml

Parameters:

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

/DocuWare/Platform/Home/DesktopInfo?orgId={orgId}&baseAddress={baseAddress}&clientSetupVersion={clientSetupVersion}

Invocations:

GET
Produces:: application/xml

Parameters:

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

/DocuWare/Platform/Home/DownloadClientSetup?baseAddress={baseAddress}&orgId={orgId}&pluginName={pluginName}

Invocations:

GET

Parameters:

baseAddress : String
orgId : String
pluginName (optional, ) : String

/DocuWare/Platform/Home/FunctionDescription

Invocations:

GET

/DocuWare/Platform/Home/IdentityServiceInfo

Invocations:

GET
Produces:: application/xml

/DocuWare/Platform/Home/LogMessages?start={start}&count={count}&level={level}&groupId={groupId}&group={group}

Invocations:

GET

Parameters:

start (optional) : Int32
count (optional) : Int32
level (optional) : LogMessageLevel, LogMessageLevel, ...
groupId : String
group (optional, True) : Boolean

/DocuWare/Platform/Home/ReflectDialogQuery

Invocations:

POST

/DocuWare/Platform/Home/ReflectStampPlacement

Invocations:

POST

/DocuWare/Platform/Home/ServiceDescriptionRedirect

Invocations:

GET

/DocuWare/Platform/Home/SignalRToken

Gets a token which can be used to authenticate on the SignalR hub

Invocations:

GET
Produces:: text/plain

/DocuWare/Platform/Home/Templates?format={format}

Invocations:

GET

Parameters:

format (optional, Default) : UriTemplatesResponseFormat

/DocuWare/Platform/Home/Token

Invocations:

GET

/DocuWare/Platform/Home/TypeDescription?type={type}

Invocations:

GET

Parameters:

type : String

/DocuWare/Platform/Home/UriTemplateHierarchy

Invocations:

GET

/DocuWare/Platform/Home/UriTemplatesDocumentation

Invocations:

GET

/DocuWare/Platform/Home/XSL

Invocations:

GET

/DocuWare/Platform/LoginRedirect?returnUrl={returnUrl}

Invocations:

GET

Parameters:

returnUrl : String

/DocuWare/Platform/Monitor/{id}

Invocations:

GET

PUT

POST

Parameters:

id : String

/DocuWare/Platform/Oidc/LoginCallback

Invocations:

GET

PUT

POST

/DocuWare/Platform/Oidc/SilentRenew

Invocations:

GET

PUT

POST

/DocuWare/Platform/Organization

Gets the full information of the specified organization.

Invocations:

GET
Produces:: Organization

/DocuWare/Platform/Organization/AreValuesInSelectList?selectListId={selectListId}

Invocations:

POST
Accepts:: SelectListValuesToCheck
Produces:: AreValuesInSelectListsResult

Parameters:

selectListId : String

/DocuWare/Platform/Organization/Dialogs?dialogType={dialogType}

Gets all dialogs of the specified organizations.

Invocations:

GET
Produces:: DialogInfos

Parameters:

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

/DocuWare/Platform/Organization/Dialogs

Gets all dialogs of the specified organizations.

Invocations:

POST
Accepts:: RequestDialogQuery
Produces:: DialogInfos

/DocuWare/Platform/Organization/Group?groupId={groupId}

Invocations:

GET
Produces:: Group

Parameters:

groupId : String

/DocuWare/Platform/Organization/Groups

Invocations:

GET
Produces:: Groups

/DocuWare/Platform/Organization/GroupUsers?groupId={groupId}

Gets all users of the organization.

Invocations:

GET
Produces:: Users

Parameters:

groupId : String: The identifier of a group.

/DocuWare/Platform/Organization/LoginToken

Invocations:

POST
Accepts:: TokenDescription
Produces:: text/plain

/DocuWare/Platform/Organization/MultiColSelectList?selectListId={selectListId}

Invocations:

GET
Produces:: MultiColSelectListInfo

Parameters:

selectListId : String

/DocuWare/Platform/Organization/MultiColSelectLists

Invocations:

GET
Produces:: MultiColSelectListInfos

/DocuWare/Platform/Organization/MultiColSelectListValues?selectListId={selectListId}&start={start}&count={count}

Invocations:

GET
Produces:: MultiColSelectListValuesResult

Parameters:

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.

/DocuWare/Platform/Organization/MultiColSelectListValues?selectListId={selectListId}

Invocations:

POST
Accepts:: MultiColSelectListValuesQuery
Produces:: MultiColSelectListValuesResult

Parameters:

selectListId : String

/DocuWare/Platform/Organization/MultiColumnSelectListValues?selectListId={selectListId}

Invocations:

POST
Accepts:: MultiColumnSelectListValuesQuery
Produces:: SelectListValuesResult

Parameters:

selectListId : String

/DocuWare/Platform/Organization/Role?roleId={roleId}

Invocations:

GET
Produces:: Role

Parameters:

roleId : String

/DocuWare/Platform/Organization/Roles

Invocations:

GET
Produces:: Roles

/DocuWare/Platform/Organization/SelectList?selectListId={selectListId}

Invocations:

GET
Produces:: SelectListInfo

Parameters:

selectListId : String

/DocuWare/Platform/Organization/SelectLists

Invocations:

GET
Produces:: SelectListInfos

/DocuWare/Platform/Organization/SelectListValues?selectListId={selectListId}&start={start}&count={count}&prefix={prefix}&returnType={returnType}

Invocations:

GET
Produces:: SelectListValuesResult

Parameters:

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.

/DocuWare/Platform/Organization/SelectListValues?selectListId={selectListId}

Invocations:

POST
Accepts:: SelectListValuesQuery
Produces:: SelectListValuesResult

Parameters:

selectListId : String

/DocuWare/Platform/Organization/SingleColumnSelectListValuesResult?selectListId={selectListId}&start={start}&count={count}&prefix={prefix}&returnType={returnType}

Invocations:

GET
Produces:: SingleColumnSelectListValues

Parameters:

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.

/DocuWare/Platform/Organization/SubstitutionLists

Invocations:

GET
Produces:: SubstitutionLists

/DocuWare/Platform/Organization/SubstitutionRules?subsListGuid={subsListGuid}

Invocations:

GET
Produces:: SubstitutionRules

Parameters:

subsListGuid : String

/DocuWare/Platform/Organization/UserByID?userId={userId}

Invocations:

GET
Produces:: User

Parameters:

userId : String

/DocuWare/Platform/Organization/UserByID

Invocations:

POST
Accepts:: User
Produces:: User

/DocuWare/Platform/Organization/UserGroups?userId={userId}

Invocations:

GET
Produces:: Groups

Parameters:

userId : String

/DocuWare/Platform/Organization/UserGroups?userId={userId}&ignoreIt={ignoreIt}

Invocations:

PUT
Accepts:: AssignmentOperation
Produces:: text/plain

Parameters:

userId : String
ignoreIt : String

/DocuWare/Platform/Organization/UserInfo

Invocations:

GET
Produces:: UserInfo

/DocuWare/Platform/Organization/UserInfo?ignoreIt={ignoreIt}

Invocations:

POST
Accepts:: User; NewUser
Produces:: User

Parameters:

ignoreIt : String

/DocuWare/Platform/Organization/UserRoles?userId={userId}

Invocations:

GET
Produces:: Roles

Parameters:

userId : String

/DocuWare/Platform/Organization/UserRoles?userId={userId}&ignoreIt={ignoreIt}

Invocations:

PUT
Accepts:: AssignmentOperation
Produces:: text/plain

Parameters:

userId : String
ignoreIt : String

/DocuWare/Platform/Organization/Users?roleId={roleId}

Gets all users of the organization.

Invocations:

GET
Produces:: Users

Parameters:

roleId : String

/DocuWare/Platform/Organization/ValidateUser

Invocations:

POST
Accepts:: UserValidation
Produces:: text/plain

/DocuWare/Platform/Organization/WebSettings

Invocations:

GET
Produces:: WebSettings

/DocuWare/Platform/Organization/WebSettings

Invocations:

POST
Accepts:: WebSettings

/DocuWare/Platform/Organizations?name={name}

Gets an organization by its name.

Invocations:

GET
Produces:: Organizations

Parameters:

name (optional) : String: The name of the requested organization. If this parameter is omitted then all organizations are returned.

/DocuWare/Platform/Schema?findSchemaType={findSchemaType}&searchElement={searchElement}&jsonSchema={jsonSchema}

Invocations:

GET

Parameters:

findSchemaType : String
searchElement (optional) : Boolean
jsonSchema (optional) : Boolean

/DocuWare/Platform/Schema/File/{id}

Invocations:

GET

Parameters:

id : String

/DocuWare/Platform/Schema/Search?findSchemaType={findSchemaType}

Invocations:

GET

Parameters:

findSchemaType : String

/DocuWare/Platform/Test/DirectDownload

Invocations:

POST

/DocuWare/Platform/Test/GetLongRunningTasks

Invocations:

POST

/DocuWare/Platform/Test/LongRunningTask

Invocations:

GET

PUT

POST

/DocuWare/Platform/Test/LongRunningTaskView

Invocations:

GET

PUT

POST

/DocuWare/Platform/Test/NastyJson

Invocations:

GET

/DocuWare/Platform/Test/Notifications

Invocations:

GET

PUT

POST

/DocuWare/Platform/Test/NotificationsFC

Invocations:

GET

PUT

POST

/DocuWare/Platform/Test/NotificationsTest

Invocations:

POST

/DocuWare/Platform/Test/Progress?id={id}

Invocations:

POST

Parameters:

id : Guid

/DocuWare/Platform/Test/Start

Invocations:

POST

/DocuWare/Platform/Test/ValidateTest?type={type}

Invocations:

POST

Parameters:

type : String

/DocuWare/Platform/Test/ValidateTestWithBA?type={type}

Invocations:

POST

Parameters:

type : String

/DocuWare/Platform/TrashBin

Invocations:

GET
Produces:: TrashBin

/DocuWare/Platform/TrashBin/BatchDelete

Invocations:

POST
Accepts:: BatchDeleteDocumentsSource
Produces:: BatchDeleteResult

/DocuWare/Platform/TrashBin/BatchRestore

Invocations:

POST
Accepts:: BatchRestoreDocumentsSource
Produces:: BatchRestoreResult

/DocuWare/Platform/TrashBin/Count

Invocations:

GET
Produces:: CountResult

/DocuWare/Platform/TrashBin/Documents?q={q}&sortOrder={sortOrder}&start={start}&count={count}&calculateTotalCount={calculateTotalCount}

Invocations:

GET
Produces:: TrashBinDocumentsTableResult

Parameters:

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.

/DocuWare/Platform/TrashBin/Query

Invocations:

POST
Accepts:: TrashBinQuery
Produces:: TrashBinDocumentsTableResult

/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.

Invocations:

GET
Produces:: TypedSelectListResult

Parameters:

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

/DocuWare/Platform/TrashBin/SelectLists

Gets typed select list values for a trash bin field with an optional prefix.

Invocations:

POST
Accepts:: TrashBinSelectListExpression
Produces:: TypedSelectListResult

/DocuWare/Platform/Users?orgid={orgid}

Invocations:

GET

Parameters:

orgid (optional) : Guid

/DocuWare/Platform/WebClient

Invocations:

GET

/DocuWare/Platform/WebClient/{orgId}/Integration?ssoLogin={ssoLogin}

Opens the new web client.

Invocations:

GET
Produces:: text/html

Parameters:

orgId : String
ssoLogin (optional) : Boolean

/DocuWare/Platform/WebClient/Client/AllInOne

Invocations:

GET

/DocuWare/Platform/WebClient/Client/AutoFillTable?did={did}&fc={fc}

Invocations:

POST

Parameters:

did : Int32
fc : String

/DocuWare/Platform/WebClient/Client/Basket?basketId={basketId}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

basketId : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/CompleteQuery

Invocations:

POST

/DocuWare/Platform/WebClient/Client/Convert

Invocations:

GET

POST

/DocuWare/Platform/WebClient/Client/DocLinks?did={did}&fc={fc}&linkId={linkId}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

did : Int32
fc : String
linkId : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/Document?did={did}&rl={rl}&fc={fc}&q={q}&culture={culture}&queryInInvariantCulture={queryInInvariantCulture}&intgParams={intgParams}

Invocations:

GET

Parameters:

did (optional) : Int32
rl : String
fc : String
q : String
culture : String
queryInInvariantCulture (optional) : Boolean
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/FileDownload?did={did}&rl={rl}&fc={fc}&q={q}&dt={dt}&queryInInvariantCulture={queryInInvariantCulture}

Invocations:

GET

Parameters:

did (optional) : Int32
rl : String
fc : String
q : String
dt (optional) : DownloadType
queryInInvariantCulture (optional) : Boolean

/DocuWare/Platform/WebClient/Client/History?did={did}&fc={fc}&culture={culture}&displayOneDoc={displayOneDoc}&intgParams={intgParams}

Invocations:

GET

Parameters:

did (optional) : Int32
fc : String
culture : String
displayOneDoc (optional) : Boolean
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/Indexes?rl={rl}&fc={fc}&did={did}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Client/LoginCallback

Invocations:

GET

PUT

POST

/DocuWare/Platform/WebClient/Client/LogInSso?orgId={orgId}&redirectLocation={redirectLocation}

Invocations:

GET

PUT

POST

Parameters:

orgId : String
redirectLocation : String

/DocuWare/Platform/WebClient/Client/Result?did={did}&rl={rl}&fc={fc}&sed={sed}&q={q}&culture={culture}&tw={tw}&displayOneDoc={displayOneDoc}&queryInInvariantCulture={queryInInvariantCulture}&intgParams={intgParams}

Invocations:

GET

Parameters:

did (optional) : Int32
rl : String
fc : String
sed : String
q : String
culture : String
tw : String
displayOneDoc (optional) : Boolean
queryInInvariantCulture (optional, False) : Boolean
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/RevokeImpersonationAsync?impersonationId={impersonationId}&type={type}

Invocations:

POST

Parameters:

impersonationId : Guid
type : ImpersonationType

/DocuWare/Platform/WebClient/Client/Search?sed={sed}&dv={dv}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

sed : String
dv : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/Separate

Invocations:

GET

/DocuWare/Platform/WebClient/Client/SilentRenew

Invocations:

GET

PUT

POST

/DocuWare/Platform/WebClient/Client/Store?dlgID={dlgID}&fc={fc}&culture={culture}&validateMandatoryFields={validateMandatoryFields}&intgParams={intgParams}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Client/StoreView?targetCabinetId={targetCabinetId}&storeDlgId={storeDlgId}&sourceCabinetId={sourceCabinetId}&docIdValues={docIdValues}&waitForDocContent={waitForDocContent}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

targetCabinetId : String
storeDlgId : String
sourceCabinetId : String
docIdValues : String
waitForDocContent : Boolean
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/SWOwner?instanceId={instanceId}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

instanceId : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/SWTask?taskId={taskId}&instanceId={instanceId}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

taskId : String
instanceId : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/UpdateBrowser

Invocations:

GET

/DocuWare/Platform/WebClient/Client/UserImpersonations

Invocations:

GET

/DocuWare/Platform/WebClient/Client/Viewer

Invocations:

GET

/DocuWare/Platform/WebClient/Client/WFTask?workflowId={workflowId}&instanceId={instanceId}&culture={culture}&taskId={taskId}&intgParams={intgParams}

Invocations:

GET

Parameters:

workflowId : String
instanceId : String
culture : String
taskId : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/Client/WFTaskList?workflowId={workflowId}&roleType={roleType}&culture={culture}&intgParams={intgParams}

Invocations:

GET

Parameters:

workflowId : String
roleType : String
culture : String
intgParams (optional) : String

/DocuWare/Platform/WebClient/ClientAccount

Invocations:

GET

/DocuWare/Platform/WebClient/ClientAccount/ChangeLanguage?lang={lang}&returnUrl={returnUrl}

Invocations:

GET

Parameters:

lang : String
returnUrl : String

/DocuWare/Platform/WebClient/ClientAccount/ChangePassword?userName={userName}&organization={organization}&showUsernameField={showUsernameField}&loginFailed={loginFailed}

Invocations:

GET

PUT

POST

Parameters:

userName (optional) : String
organization (optional) : String
showUsernameField (optional, 1) : Int32
loginFailed (optional, False) : Boolean

/DocuWare/Platform/WebClient/ClientAccount/ChangePassword?model={model}

Invocations:

POST

Parameters:

model : WebClientChangePasswordModel

/DocuWare/Platform/WebClient/ClientAccount/ChangePasswordManually

Invocations:

POST

/DocuWare/Platform/WebClient/ClientAccount/Disconnect

Invocations:

GET

POST

/DocuWare/Platform/WebClient/ClientAccount/FallbackLogIn?loginModel={loginModel}&isIntegrationLink={isIntegrationLink}

Invocations:

GET

Parameters:

loginModel : LogOnWithIdentityModel
isIntegrationLink (optional) : Boolean

/DocuWare/Platform/WebClient/ClientAccount/FallbackLogIn?model={model}

Invocations:

POST

Parameters:

model : WebClientLoginModel

/DocuWare/Platform/WebClient/ClientAccount/GetRefreshTokensInfo

Invocations:

GET

/DocuWare/Platform/WebClient/ClientAccount/LogInNtlm?model={model}

Invocations:

POST

Parameters:

model : WebClientLoginModel

/DocuWare/Platform/WebClient/ClientAccount/LogInNtlm/{autoLogin}?orgId={orgId}

Invocations:

GET

Parameters:

autoLogin (optional) : Boolean
orgId : String

/DocuWare/Platform/WebClient/ClientAccount/LogOff?openedInSeparateWindow={openedInSeparateWindow}&auto={auto}

Invocations:

GET

POST

Parameters:

openedInSeparateWindow : Boolean
auto : Boolean

/DocuWare/Platform/WebClient/ClientAccount/ResetPassword?userName={userName}&organization={organization}

Invocations:

POST

Parameters:

userName : String
organization : String

/DocuWare/Platform/WebClient/ClientAccount/RevokeRefreshToken?userId={userId}&key={key}

Invocations:

POST

Parameters:

userId : String
key : String

/DocuWare/Platform/WebClient/ClientAccount/TokenChangePassword?token={token}&password={password}

Invocations:

POST

Parameters:

token : String
password : String

/DocuWare/Platform/WebClient/Forms/{formName}?orgId={orgId}

Invocations:

GET
Produces:: text/html

Parameters:

formName : String
orgId : String

/DocuWare/Platform/WebClient/Settings?orgId={orgId}&openInNewWindow={openInNewWindow}&culture={culture}&passwordChanged={passwordChanged}

Opens the new web client.

Invocations:

POST
Produces:: text/html

Parameters:

orgId (optional) : String: The organization which is used for the web client. If this is missing or empty, you are redirected to choose your organization in case you can access multiple organizations.
openInNewWindow (optional) : Boolean
culture : String
passwordChanged (optional, False) : Boolean

/DocuWare/Platform/WebClient/Settings/AllInOne

Invocations:

POST

/DocuWare/Platform/WebClient/Settings/Basket?basketId={basketId}&culture={culture}

Invocations:

POST

Parameters:

basketId : String
culture : String

/DocuWare/Platform/WebClient/Settings/CheckSession

Invocations:

GET

/DocuWare/Platform/WebClient/Settings/DocLinks?did={did}&fc={fc}&linkId={linkId}&culture={culture}

Invocations:

POST

Parameters:

did : Int32
fc : String
linkId : String
culture : String

/DocuWare/Platform/WebClient/Settings/Document?did={did}&rl={rl}&fc={fc}&q={q}&culture={culture}&queryInInvariantCulture={queryInInvariantCulture}

Invocations:

POST

Parameters:

did (optional) : Int32
rl : String
fc : String
q : String
culture : String
queryInInvariantCulture (optional) : Boolean

/DocuWare/Platform/WebClient/Settings/History?did={did}&fc={fc}&culture={culture}&displayOneDoc={displayOneDoc}

Invocations:

POST

Parameters:

did (optional) : Int32
fc : String
culture : String
displayOneDoc (optional) : Boolean

/DocuWare/Platform/WebClient/Settings/Indexes?rl={rl}&fc={fc}&did={did}&culture={culture}

Invocations:

POST

Parameters:

rl : String
fc : String
did : Int32
culture : String

/DocuWare/Platform/WebClient/Settings/Result?did={did}&rl={rl}&fc={fc}&sed={sed}&q={q}&culture={culture}&tw={tw}&displayOneDoc={displayOneDoc}&queryInInvariantCulture={queryInInvariantCulture}

Invocations:

POST

Parameters:

did (optional) : Int32
rl : String
fc : String
sed : String
q : String
culture : String
tw : String
displayOneDoc (optional) : Boolean
queryInInvariantCulture (optional, False) : Boolean

/DocuWare/Platform/WebClient/Settings/Search?sed={sed}&dv={dv}&culture={culture}

Invocations:

POST

Parameters:

sed : String
dv : String
culture : String

/DocuWare/Platform/WebClient/Settings/Separate

Invocations:

POST

/DocuWare/Platform/WebClient/Settings/Store?dlgID={dlgID}&fc={fc}&culture={culture}&validateMandatoryFields={validateMandatoryFields}

Invocations:

POST

Parameters:

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

/DocuWare/Platform/WebClient/Settings/StoreView?targetCabinetId={targetCabinetId}&storeDlgId={storeDlgId}&sourceCabinetId={sourceCabinetId}&docIdValues={docIdValues}&waitForDocContent={waitForDocContent}&culture={culture}

Invocations:

POST

Parameters:

targetCabinetId : String
storeDlgId : String
sourceCabinetId : String
docIdValues : String
waitForDocContent : Boolean
culture : String

/DocuWare/Platform/WebClient/Settings/SWOwner?instanceId={instanceId}&culture={culture}

Invocations:

POST

Parameters:

instanceId : String
culture : String

/DocuWare/Platform/WebClient/Settings/SWTask?taskId={taskId}&instanceId={instanceId}&culture={culture}

Invocations:

POST

Parameters:

taskId : String
instanceId : String
culture : String

/DocuWare/Platform/WebClient/Settings/UICulture?currentLocale={currentLocale}

Invocations:

POST

Parameters:

currentLocale : String

/DocuWare/Platform/WebClient/Settings/Viewer

Invocations:

POST

/DocuWare/Platform/WebClient/Settings/WFTask?workflowId={workflowId}&instanceId={instanceId}&culture={culture}&taskId={taskId}

Invocations:

POST

Parameters:

workflowId : String
instanceId : String
culture : String
taskId : String

/DocuWare/Platform/WebClient/Settings/WFTaskList?workflowId={workflowId}&roleType={roleType}&culture={culture}

Invocations:

POST

Parameters:

workflowId : String
roleType : String
culture : String

/DocuWare/Platform/WebClient/Viewer

Invocations:

GET

/DocuWare/Platform/WebClient/Viewer/GetDocument?fileCabinetId={fileCabinetId}&docId={docId}&withContentArea={withContentArea}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Viewer/GetInstalledFonts

Invocations:

GET

/DocuWare/Platform/WebClient/Viewer/GetJSResources?culture={culture}

Invocations:

GET

Parameters:

culture : String

/DocuWare/Platform/WebClient/Viewer/GetPage?fileCabinetId={fileCabinetId}&docId={docId}&sectionId={sectionId}&page={page}&withContentArea={withContentArea}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Viewer/GetSection?fileCabinetId={fileCabinetId}&docId={docId}&sectionId={sectionId}&page={page}&withContentArea={withContentArea}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Viewer/LogOff

Invocations:

GET

POST

/DocuWare/Platform/WebClient/Viewer/Stamps?fileCabinetId={fileCabinetId}&stampType={stampType}

Invocations:

GET

Parameters:

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

/DocuWare/Platform/WebClient/Viewer/TokenLogon?token={token}&rememberMe={rememberMe}&instanceId={instanceId}

Invocations:

GET

DELETE

POST

Parameters:

token : String
rememberMe (optional) : Boolean
instanceId : String

/DocuWare/Platform/WebClient/Viewer/ValidateStampFields?fileCabinetId={fileCabinetId}

Invocations:

POST
Accepts:: StampFormFieldValues

Parameters:

fileCabinetId : String

/DocuWare/Platform/Workflow/ControllerWorkflows

Invocations:

GET
Produces:: Workflows

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}

Invocations:

GET
Produces:: Workflow

Parameters:

id : String

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}/Count

Invocations:

GET
Produces:: WorkflowTasksCount

Parameters:

id : String

/DocuWare/Platform/Workflow/ControllerWorkflows/{id}/Tasks?sortOrder={sortOrder}&start={start}&count={count}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}

Invocations:

GET
Produces:: WorkflowTasks

POST
Accepts:: TasksQuery
Produces:: WorkflowTasks

Parameters:

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.

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Instance

Invocations:

GET
Produces:: text/plain; Instance

DELETE
Produces:: text/plain; Instance

Parameters:

workflowId : String
instanceId : String

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}?loadColumnValues={loadColumnValues}&maintenanceMode={maintenanceMode}

Invocations:

GET
Produces:: WorkflowTasks

Parameters:

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

/DocuWare/Platform/Workflow/ControllerWorkflows/{workflowId}/Instances/{instanceId}/Tasks/{taskId}/StampSettings

Invocations:

GET
Produces:: DecisionsStampSettings

Parameters:

workflowId : String
instanceId : String
taskId : String

/DocuWare/Platform/Workflow/DesignerWorkflows

Invocations:

GET
Produces:: DesignerWorkflows

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}

Invocations:

GET
Produces:: DesignerWorkflow

Parameters:

id : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Instances

Invocations:

GET
Produces:: DesignerInstances

Parameters:

id : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Instances/{instanceId}

Invocations:

GET
Produces:: DesignerInstance

DELETE
Produces:: DesignerInstance

Parameters:

id : String
instanceId : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions

Invocations:

GET
Produces:: DesignerWorkflowVersions

Parameters:

id : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions/{versionId}

Invocations:

GET
Produces:: DesignerWorkflowVersion

Parameters:

id : String
versionId : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/Versions/{versionId}/Instances

Invocations:

GET
Produces:: DesignerInstances

Parameters:

id : String
versionId : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances

Invocations:

GET
Produces:: DesignerWaitingInstances

Parameters:

id : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances/{instanceId}

Invocations:

GET
Produces:: DesignerWaitingInstance

Parameters:

id : String
instanceId : String

/DocuWare/Platform/Workflow/DesignerWorkflows/{id}/WaitingInstances/{instanceId}/Continue

Invocations:

POST
Produces:: String

Parameters:

id : String
instanceId : String

/DocuWare/Platform/Workflow/RequestsWorkflows

Invocations:

GET
Produces:: String; WorkflowRequests

POST
Accepts:: RequestSettings
Produces:: String; WorkflowRequests

/DocuWare/Platform/Workflow/RequestsWorkflows/Tasks?start={start}&count={count}&sortOrder={sortOrder}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}

Invocations:

GET
Produces:: RequestTasks

POST
Accepts:: TasksQuery
Produces:: RequestTasks

Parameters:

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.

/DocuWare/Platform/Workflow/RequestsWorkflows/TasksCount

Invocations:

GET
Produces:: WorkflowTasksCount

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows?start={start}&count={count}&sortOrder={sortOrder}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}

Invocations:

GET
Produces:: OwnWorkflows

POST
Accepts:: TasksQuery
Produces:: OwnWorkflows

Parameters:

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.

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/History

Invocations:

GET
Produces:: InstanceHistory

Parameters:

workflowId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Self

Invocations:

GET
Produces:: OwnWorkflow; String

DELETE
Produces:: OwnWorkflow; String

Parameters:

workflowId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}

Invocations:

GET
Produces:: RequestTask

Parameters:

workflowId : String
taskId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/Confirm

Invocations:

POST
Accepts:: RequestConfirmedData

Parameters:

workflowId : String
taskId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/ReadStatus

Invocations:

PUT
Accepts:: ReadStatus
Produces:: text/plain

Parameters:

workflowId : String
taskId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/Workflows/{workflowId}/Tasks/{taskId}/StampSettings

Invocations:

GET
Produces:: RequestDecisionsStampSettings

Parameters:

workflowId : String
taskId : String

/DocuWare/Platform/Workflow/RequestsWorkflows/WorkflowsCount

Invocations:

GET
Produces:: WorkflowTasksCount

/DocuWare/Platform/Workflow/Workflows

Invocations:

GET
Produces:: Workflows

/DocuWare/Platform/Workflow/Workflows/{id}

Invocations:

GET
Produces:: Workflow

Parameters:

id : String

/DocuWare/Platform/Workflow/Workflows/{id}/Count

Invocations:

GET
Produces:: WorkflowTasksCount

Parameters:

id : String

/DocuWare/Platform/Workflow/Workflows/{id}/Tasks?sortOrder={sortOrder}&start={start}&count={count}&format={format}&encodingName={encodingName}&csvDelimiter={csvDelimiter}&csvIsUtc={csvIsUtc}

Invocations:

GET
Produces:: WorkflowTasks

POST
Accepts:: TasksQuery
Produces:: WorkflowTasks

Parameters:

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.