Freigeben über


DocuWare GmbH (Preview)

Access common DocuWare features from within your flows.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name DocuWare GmbH
URL https://support.docuware.com
Email support@docuware.com
Connector Metadata
Publisher DocuWare GmbH
Website https://start.docuware.com
Privacy policy https://start.docuware.com/data-privacy
Categories Content and Files;Productivity

DocuWare provides a powerful and extensive REST API. With DocuWare's Power Automate Connector, users can now leverage many of the most common features of the DocuWare REST API in Power Automate. This allows the user greater flexibility to create flows that fully address their business needs, thanks to the seamless integration with DocuWare.

Prerequisites

You will need the following to proceed:

  • A DocuWare Cloud subscription
  • A Microsoft Power Apps or Power Automate account

How to get credentials

Creating a new API Key is easy and can be done from within DocuWare.

Follow these steps to create a new API Key in DocuWare:

  1. Log into your DocuWare account that you want to use with Power Automate
  2. From the main menu, navigate to "Configurations"
  3. From the "Configurations" page, go to the "Integrations" section and click on the icon for "Power Automate API Keys"
    • If you do not see the "Power Automate API Keys" icon, then it is possible your user does not have the correct permissions. Contact your DocuWare administrator to resolve this.
  4. Click the "Create API Key" button
  5. Fill out the "Name" and "Description" (optional) values, and click "Create"
    • After pressing "Create", there might be a slight delay as the configuration process creates your key.
    • Also, be sure to save your API Key. This will be your only opportunity to view the full API Key. If you lose this key, you will need to create another one.

At this point, you now have a valid API Key that can be used in Power Automate to create a connection to DocuWare. This connection can then be used with the DocuWare Power Automate Connector.

Get started with your connector

Creating a connection in Power Automate is easy and can be done when you are creating your flows.

Follow these steps to create a new connection in Power Automate:

  1. Login to Power Automate
  2. Create a new flow or open up an existing flow
  3. Add an activity from the DocuWare Power Automate connector to your flow
    • Click "+ New Step" to add a new step to your flow
    • When presented with "Choose an operation", select "All" from the category selection, and then type "DocuWare" in the search field.
    • Select the "DocuWare" connector and then choose from the list of available actions.
  4. When the action is added to the flow, you will be prompted to create a new connection.
  5. Enter a connection name ("Connection Name") and the API Key ("API Key") that you received from DocuWare in the previous section and click "Create".

From this point forward, all activities that are added from the DocuWare connector will use this connection. You can create additional connections by clicking on the "..." in the top right corner of an activity, and then clicking "+ Add new connection" at the bottom of the menu that pops up.

Known issues and limitations

At this time, DocuWare's Power Automate connector is not supported in the new Power Automate Flow designer.

Common errors and remedies

HTTP Error Codes:

  • 400: Ensure that you have filled out all required fields in the activity. Some fields are required and must be filled out before the activity can be run.
  • 401: Ensure you have entered the correct API Key. You can also check the status of the API Key in the "Configurations" page, under "Integrations" -> "Power Automate API Keys".
  • 404: Ensure that the specified document, and/or file cabinet exist and that you have access to them. If the document or file cabinet do not exist, or you do not have access to them, then you will receive an error 404.
  • 500: This is a generic error that can be caused by a number of different issues. If you receive this error, please contact DocuWare Support for assistance.

FAQ

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API key securestring The API key for accessing DocuWare True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Append a File

Appends a file/section to an existing document.

Delete a Document

Deletes a document from a file cabinet or document tray.

Delete a File

Deletes a file/section from an existing document.

Download a Document

Downloads a document from a file cabinet or document tray.

Download a File

Downloads a file/section of a document stored in a file cabinet or document tray.

Get Dialog Fields

Gets the fields for a dialog

Get Dialogs

Gets a list of dialogs for a file cabinet or document tray.

Get Document Information

Gets information about a document.

Get File Cabinet Fields

Gets a list of fields for a file cabinet.

Get File Cabinets and Document Trays

Gets a list of file cabinets and/or document trays.

Get Organization

Get the organization name.

Get Stamp Fields

Gets a list of fields for a stamp.

Get Stamps

Gets a list of stamps for a file cabinet or document tray.

Import to Document Tray

Import a new document into a document tray.

Place a Stamp

Places a stamp on a document.

Replace a File

Replaces a file/section in an existing document.

Search for Documents

Search a file cabinet for documents matching the specified criteria.

Store to File Cabinet

Stores a new document to a file cabinet.

Transfer Documents

Moves one or more documents from one file cabinet/document tray to another.

Update Index Fields

Updates the index fields of a document.

Append a File

Appends a file/section to an existing document.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocID True string

Specify the ID of the document to append to.

File Contents
file file

Specify the contents of the file to store.

Returns

Name Path Type Description
SignatureStatus
SignatureStatus array of string

SignatureStatus

SectionId
SectionId string

SectionId

ContentType
ContentType string

ContentType

HaveMorePages
HaveMorePages boolean

HaveMorePages

PageCount
PageCount integer

PageCount

FileSize
FileSize integer

FileSize

OriginalFileName
OriginalFileName string

OriginalFileName

ContentModified
ContentModified string

ContentModified

HasTextAnnotation
HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
AnnotationsPreview boolean

AnnotationsPreview

Delete a Document

Deletes a document from a file cabinet or document tray.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinetID True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentID True integer

Specify the ID of the document you want to delete.

Returns

Delete a File

Deletes a file/section from an existing document.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentID True integer

Specify the ID of the document to delete from.

File Number
FileNumber True integer

Specify the file number to delete.

Returns

Download a Document

Downloads a document from a file cabinet or document tray.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinetID True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentId True integer

Specify the ID of the document you want to download.

Document Format
DocumentFormat True string

Select the format for the downloaded document.

Returns

Body

Body
binary

Download a File

Downloads a file/section of a document stored in a file cabinet or document tray.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinetID True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentId True integer

Specify the ID of the document with the file you want to download.

File Number
FileNumber True string

Specify the file number of the file you want to download.

Document Format
DocumentFormat True string

Select the format for the downloaded document.

Returns

Body

Body
binary

Get Dialog Fields

Gets the fields for a dialog

Parameters

Name Key Required Type Description
File Cabinet
FileCabinet True string

Select the File Cabinet

Dialog
DialogId True string

Select the dialog to get the fields for.

Returns

Name Path Type Description
Fields
Fields array of object

Fields

DBFieldName
Fields.DBFieldName string

DBFieldName

DWFieldType
Fields.DWFieldType string

DWFieldType

DisplayName
Fields.DisplayName string

DisplayName

ReadOnly
Fields.ReadOnly boolean

ReadOnly

Visible
Fields.Visible boolean

Visible

Get Dialogs

Gets a list of dialogs for a file cabinet or document tray.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray to get dialogs from.

Dialog Type
DialogType string

Select the type of dialogs to return.

Returns

Name Path Type Description
Dialogs
Dialogs array of object

Dialogs

Name
Dialogs.Name string

Name

Guid
Dialogs.Guid string

Guid

Color
Dialogs.Color string

Color

IsDefault
Dialogs.IsDefault boolean

IsDefault

Type
Dialogs.Type string

Type

FileCabinetId
Dialogs.FileCabinetId string

FileCabinetId

Get Document Information

Gets information about a document.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinetID True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentID True integer

Specify the ID of the document you want information on.

Returns

Name Path Type Description
Sections
Sections array of object

Sections

SignatureStatus
Sections.SignatureStatus array of string

SignatureStatus

SectionId
Sections.SectionId string

SectionId

ContentType
Sections.ContentType string

ContentType

HaveMorePages
Sections.HaveMorePages boolean

HaveMorePages

PageCount
Sections.PageCount integer

PageCount

FileSize
Sections.FileSize integer

FileSize

OriginalFileName
Sections.OriginalFileName string

OriginalFileName

ContentModified
Sections.ContentModified string

ContentModified

HasTextAnnotation
Sections.HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
Sections.AnnotationsPreview boolean

AnnotationsPreview

DocumentId
DocumentId integer

DocumentId

IndexFields
IndexFields object

IndexFields

DocumentTitle
DocumentTitle string

DocumentTitle

FileCabinetId
FileCabinetId string

FileCabinetId

TotalPages
TotalPages integer

TotalPages

FileSize
FileSize integer

FileSize

ContentType
ContentType string

ContentType

VersionStatus
VersionStatus string

VersionStatus

isCold
DocumentFlags.isCold boolean

isCold

isDBRecord
DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
DocumentFlags.isProtected boolean

isProtected

isDeleted
DocumentFlags.isDeleted boolean

isDeleted

isEmail
DocumentFlags.isEmail boolean

isEmail

Get File Cabinet Fields

Gets a list of fields for a file cabinet.

Parameters

Name Key Required Type Description
File Cabinet
FileCabinet True string

Select the File Cabinet to get fields for.

Field Type
FieldType string

Select the type of fields to return.

Returns

Name Path Type Description
Fields
Fields array of object

Fields

TableFieldColumns
Fields.TableFieldColumns array of object

TableFieldColumns

DBFieldName
Fields.TableFieldColumns.DBFieldName string

DBFieldName

DWFieldType
Fields.TableFieldColumns.DWFieldType string

DWFieldType

DisplayName
Fields.TableFieldColumns.DisplayName string

DisplayName

DropLeadingBlanks
Fields.TableFieldColumns.DropLeadingBlanks boolean

DropLeadingBlanks

DropLeadingZero
Fields.TableFieldColumns.DropLeadingZero boolean

DropLeadingZero

FieldInfoText
Fields.TableFieldColumns.FieldInfoText string

FieldInfoText

FixedEntry
Fields.TableFieldColumns.FixedEntry string

FixedEntry

Length
Fields.TableFieldColumns.Length integer

Length

NotEmpty
Fields.TableFieldColumns.NotEmpty boolean

NotEmpty

Precision
Fields.TableFieldColumns.Precision integer

Precision

Scope
Fields.TableFieldColumns.Scope string

Scope

UsedAsDocumentName
Fields.UsedAsDocumentName boolean

UsedAsDocumentName

DBFieldName
Fields.DBFieldName string

DBFieldName

DWFieldType
Fields.DWFieldType string

DWFieldType

DisplayName
Fields.DisplayName string

DisplayName

DropLeadingBlanks
Fields.DropLeadingBlanks boolean

DropLeadingBlanks

DropLeadingZero
Fields.DropLeadingZero boolean

DropLeadingZero

FieldInfoText
Fields.FieldInfoText string

FieldInfoText

FixedEntry
Fields.FixedEntry string

FixedEntry

Length
Fields.Length integer

Length

NotEmpty
Fields.NotEmpty boolean

NotEmpty

Precision
Fields.Precision integer

Precision

Scope
Fields.Scope string

Scope

Get File Cabinets and Document Trays

Gets a list of file cabinets and/or document trays.

Parameters

Name Key Required Type Description
File Cabinet Type
FileCabinetType True string

Select which types you want returned.

Returns

Name Path Type Description
FileCabinets
FileCabinets array of object

FileCabinets

Name
FileCabinets.Name string

Name

Guid
FileCabinets.Guid string

Guid

Color
FileCabinets.Color string

Color

IsTray
FileCabinets.IsTray boolean

IsTray

Get Organization

Get the organization name.

Returns

Name Path Type Description
Name
Name string

Name

Get Stamp Fields

Gets a list of fields for a stamp.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray with the desired stamp.

Stamp
Stamp True string

Select the stamp to get its fields.

Returns

Name Path Type Description
Fields
Fields array of object

Fields

Id
Fields.Id string

Id

Label
Fields.Label string

Label

DisplayName
Fields.DisplayName string

DisplayName

Get Stamps

Gets a list of stamps for a file cabinet or document tray.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray to get stamps from.

Returns

Name Path Type Description
Stamps
Stamps array of object

Stamps

Id
Stamps.Id string

Id

Name
Stamps.Name string

Name

DisplayName
Stamps.DisplayName string

DisplayName

Color
Stamps.Color string

Color

Signature
Stamps.Signature string

Signature

PasswordProtected
Stamps.PasswordProtected boolean

PasswordProtected

Overwrite
Stamps.Overwrite boolean

Overwrite

Type
Stamps.Type string

Type

FileCabinetId
Stamps.FileCabinetId string

FileCabinetId

Import to Document Tray

Import a new document into a document tray.

Parameters

Name Key Required Type Description
Document Tray
DocumentTray True string

Select the Document Tray to import to.

Store Dialog
StoreDialogId string

Select the store dialog to use during import.

Index Data
index string

Specify the index data for the document.

File Contents
file file

Specify the contents of the file to import.

Returns

Name Path Type Description
Sections
Sections array of object

Sections

SignatureStatus
Sections.SignatureStatus array of string

SignatureStatus

SectionId
Sections.SectionId string

SectionId

ContentType
Sections.ContentType string

ContentType

HaveMorePages
Sections.HaveMorePages boolean

HaveMorePages

PageCount
Sections.PageCount integer

PageCount

FileSize
Sections.FileSize integer

FileSize

OriginalFileName
Sections.OriginalFileName string

OriginalFileName

ContentModified
Sections.ContentModified string

ContentModified

HasTextAnnotation
Sections.HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
Sections.AnnotationsPreview boolean

AnnotationsPreview

DocumentId
DocumentId integer

DocumentId

IndexFields
IndexFields object

IndexFields

DocumentTitle
DocumentTitle string

DocumentTitle

FileCabinetId
FileCabinetId string

FileCabinetId

TotalPages
TotalPages integer

TotalPages

FileSize
FileSize integer

FileSize

ContentType
ContentType string

ContentType

VersionStatus
VersionStatus string

VersionStatus

isCold
DocumentFlags.isCold boolean

isCold

isDBRecord
DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
DocumentFlags.isProtected boolean

isProtected

isDeleted
DocumentFlags.isDeleted boolean

isDeleted

isEmail
DocumentFlags.isEmail boolean

isEmail

Place a Stamp

Places a stamp on a document.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinetID True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentID True integer

Specify the ID of the document you want to stamp.

File Number
FileNumber True integer

Specify the file/section containing the page to be stamped.

Page Number
PageNumber True integer

Specify the page number to place the stamp on.

Layer
Layer True integer

Specify the document layer to place the stamp on [1-5]

Horizontal Position (X position)
PositionX number

[Optional] Position from the left edge of the page in mm.

Vertical Position (Y position)
PositionY number

[Optional] Position from the upper edge of the page in mm.

Stamp
StampId True string

Select or specify the stamp to be used.

Password
Password string

Specify the password for the stamp (if required).

Name
Name string

Specify a field name.

Value
Value string

Specify a field value.

Returns

Name Path Type Description
User
Created.User string

User

Time
Created.Time string

Time

Type
Type string

Type

Color
Color string

Color

Rotation
Rotation integer

Rotation

Transparent
Transparent boolean

Transparent

StrokeWidth
StrokeWidth integer

StrokeWidth

Guid
Guid string

Guid

Replace a File

Replaces a file/section in an existing document.

Parameters

Name Key Required Type Description
File Cabinet/Document Tray
FileCabinet True string

Select the File Cabinet or Document Tray with your document.

Document ID
DocumentID True integer

Specify the ID of the document with the file to replace.

File Number
FileNumber True integer

Specify the file number to replace.

File Contents
file file

Specify the contents of the file to store.

Returns

Name Path Type Description
SignatureStatus
SignatureStatus array of string

SignatureStatus

SectionId
SectionId string

SectionId

ContentType
ContentType string

ContentType

HaveMorePages
HaveMorePages boolean

HaveMorePages

PageCount
PageCount integer

PageCount

FileSize
FileSize integer

FileSize

OriginalFileName
OriginalFileName string

OriginalFileName

ContentModified
ContentModified string

ContentModified

HasTextAnnotation
HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
AnnotationsPreview boolean

AnnotationsPreview

Search for Documents

Search a file cabinet for documents matching the specified criteria.

Parameters

Name Key Required Type Description
File Cabinet
FileCabinet True string

Select the File Cabinet to search.

Search Dialog
SearchDialogId True string

Select the search dialog to use for searching.

Search Query
SearchQuery True

Returns

Name Path Type Description
Count
Count integer

Count

Documents
Documents array of object

Documents

Sections
Documents.Sections array of

Sections

DocumentId
Documents.DocumentId integer

DocumentId

IndexFields
Documents.IndexFields object

IndexFields

DocumentTitle
Documents.DocumentTitle string

DocumentTitle

FileCabinetId
Documents.FileCabinetId string

FileCabinetId

TotalPages
Documents.TotalPages integer

TotalPages

FileSize
Documents.FileSize integer

FileSize

ContentType
Documents.ContentType string

ContentType

VersionStatus
Documents.VersionStatus string

VersionStatus

isCold
Documents.DocumentFlags.isCold boolean

isCold

isDBRecord
Documents.DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
Documents.DocumentFlags.isProtected boolean

isProtected

isDeleted
Documents.DocumentFlags.isDeleted boolean

isDeleted

isEmail
Documents.DocumentFlags.isEmail boolean

isEmail

Store to File Cabinet

Stores a new document to a file cabinet.

Parameters

Name Key Required Type Description
File Cabinet
FileCabinet True string

Select the File Cabinet to store to.

Store Dialog
StoreDialogId True string

Select the store dialog to use for storing.

Index Data
index string

Specify the index data for the document.

File Contents
file file

Specify the contents of the file to store.

Returns

Name Path Type Description
Sections
Sections array of object

Sections

SignatureStatus
Sections.SignatureStatus array of string

SignatureStatus

SectionId
Sections.SectionId string

SectionId

ContentType
Sections.ContentType string

ContentType

HaveMorePages
Sections.HaveMorePages boolean

HaveMorePages

PageCount
Sections.PageCount integer

PageCount

FileSize
Sections.FileSize integer

FileSize

OriginalFileName
Sections.OriginalFileName string

OriginalFileName

ContentModified
Sections.ContentModified string

ContentModified

HasTextAnnotation
Sections.HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
Sections.AnnotationsPreview boolean

AnnotationsPreview

DocumentId
DocumentId integer

DocumentId

IndexFields
IndexFields object

IndexFields

DocumentTitle
DocumentTitle string

DocumentTitle

FileCabinetId
FileCabinetId string

FileCabinetId

TotalPages
TotalPages integer

TotalPages

FileSize
FileSize integer

FileSize

ContentType
ContentType string

ContentType

VersionStatus
VersionStatus string

VersionStatus

isCold
DocumentFlags.isCold boolean

isCold

isDBRecord
DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
DocumentFlags.isProtected boolean

isProtected

isDeleted
DocumentFlags.isDeleted boolean

isDeleted

isEmail
DocumentFlags.isEmail boolean

isEmail

Transfer Documents

Moves one or more documents from one file cabinet/document tray to another.

Parameters

Name Key Required Type Description
Destination File Cabinet/Document Tray
DestinationFileCabinetID True string

Select the destination File Cabinet or Document Tray.

Store Dialog
StoreDialogID string

Select the store dialog for indexing the documents being moved.

Source File Cabinet/Document Tray
SourceFileCabinetId True string

Select the source File Cabinet or Document Tray.

ID
DocumentId integer

Specify a document ID.

Name
Name string

Select or specify a field name.

Value
Value string

Specify a field value.

Keep Source
KeepSource boolean

Choose whether the source documents should be deleted or not.

Fill Intellix
FillIntellix boolean

Choose whether intelligent indexing should be used when storing.

Returns

Name Path Type Description
Count
Count integer

Count

Documents
Documents array of object

Documents

Sections
Documents.Sections array of object

Sections

SignatureStatus
Documents.Sections.SignatureStatus array of string

SignatureStatus

SectionId
Documents.Sections.SectionId string

SectionId

ContentType
Documents.Sections.ContentType string

ContentType

HaveMorePages
Documents.Sections.HaveMorePages boolean

HaveMorePages

PageCount
Documents.Sections.PageCount integer

PageCount

FileSize
Documents.Sections.FileSize integer

FileSize

OriginalFileName
Documents.Sections.OriginalFileName string

OriginalFileName

ContentModified
Documents.Sections.ContentModified string

ContentModified

HasTextAnnotation
Documents.Sections.HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
Documents.Sections.AnnotationsPreview boolean

AnnotationsPreview

DocumentId
Documents.DocumentId integer

DocumentId

IndexFields
Documents.IndexFields object

IndexFields

DocumentTitle
Documents.DocumentTitle string

DocumentTitle

FileCabinetId
Documents.FileCabinetId string

FileCabinetId

TotalPages
Documents.TotalPages integer

TotalPages

FileSize
Documents.FileSize integer

FileSize

ContentType
Documents.ContentType string

ContentType

VersionStatus
Documents.VersionStatus string

VersionStatus

isCold
Documents.DocumentFlags.isCold boolean

isCold

isDBRecord
Documents.DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
Documents.DocumentFlags.isProtected boolean

isProtected

isDeleted
Documents.DocumentFlags.isDeleted boolean

isDeleted

isEmail
Documents.DocumentFlags.isEmail boolean

isEmail

Update Index Fields

Updates the index fields of a document.

Parameters

Name Key Required Type Description
File Cabinet
FileCabinetID True string

Select the File Cabinet with the document to update.

Document ID
DocumentID True integer

Specify the ID of the document to update.

Name
Name string

Select or specify an index field.

Value
Value string

Specify an index value.

Returns

Name Path Type Description
Sections
Sections array of object

Sections

SignatureStatus
Sections.SignatureStatus array of string

SignatureStatus

SectionId
Sections.SectionId string

SectionId

ContentType
Sections.ContentType string

ContentType

HaveMorePages
Sections.HaveMorePages boolean

HaveMorePages

PageCount
Sections.PageCount integer

PageCount

FileSize
Sections.FileSize integer

FileSize

OriginalFileName
Sections.OriginalFileName string

OriginalFileName

ContentModified
Sections.ContentModified string

ContentModified

HasTextAnnotation
Sections.HasTextAnnotation boolean

HasTextAnnotation

AnnotationsPreview
Sections.AnnotationsPreview boolean

AnnotationsPreview

DocumentId
DocumentId integer

DocumentId

IndexFields
IndexFields object

IndexFields

DocumentTitle
DocumentTitle string

DocumentTitle

FileCabinetId
FileCabinetId string

FileCabinetId

TotalPages
TotalPages integer

TotalPages

FileSize
FileSize integer

FileSize

ContentType
ContentType string

ContentType

VersionStatus
VersionStatus string

VersionStatus

isCold
DocumentFlags.isCold boolean

isCold

isDBRecord
DocumentFlags.isDBRecord boolean

isDBRecord

isCheckedOut
DocumentFlags.isCheckedOut boolean

isCheckedOut

isCopyRightProtected
DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected

isVoiceAvailable
DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable

hasAppendedDocuments
DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments

isProtected
DocumentFlags.isProtected boolean

isProtected

isDeleted
DocumentFlags.isDeleted boolean

isDeleted

isEmail
DocumentFlags.isEmail boolean

isEmail

Definitions

binary

This is the basic data type 'binary'.