Partilhar via


InfoShare

InfoShare is designed for use in businesses seeking to optimise the way they manage digital documents, information, binders and processes.

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 Kendox Support
URL https://kendox.com/en/service/support-services
Email support@kendox.com
Connector Metadata
Publisher Kendox AG
Website https://www.kendox.com/en
Privacy policy https://www.kendox.com/en/about-us/data-protection
Categories Collaboration;Content and Files

Kendox InfoShare provides a powerful and very extensive REST API. Using this API, you can create and manage documents and processes within InfoShare. Together with the Kendox InfoShare Power Automate Connector you can streamline content processes across a widespread application landscape thus avoiding information silos. The InfoShare Connector provides you actions for managing documents and processes.

Prerequisites

  • A license to use this connector available via sales@kendox.com.
  • Kendox InfoShare with the WCF service endpoints reachable online.
  • Kendox InfoShare login credentials.

How to get credentials?

The connector API Key can be purchased via e-mail request using sales@kendox.com. The WCF service endpoint will be provided from Kendox (Cloud) or from a Kendox partner, who implemented the respective InfoShare instance.

How to use the connector?

First you have to create a connection to the connector. For the connection, an API Key is required. You will get it from sales@kendox.com. The first action is always the Logon or LogonWithHashedPasswort action. These actions return a connection Id, which is required for all further actions. If the connection Id is not be used for more than 10 minutes, the connection Id expires and you have to re-logon with the Logon or LogonWithHashedPasswort action.

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 this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Close an open process

Close an open process

Close current task and assign user to next task

Close current task and assign user to next task

Close task and continue process

Close task and continue process

Create a user table

Create a user table

Create document

Create document

Create process

Create process

Delete user table rows

Delete user table rows

Document Search

Document Search

Get document

Get document

Get document properties

Get document properties

Get file content

Get file content

Get file content converted

Convert file content to different format. Add annotation or overlay to file content

Get process

Get Process

Get process properties

Get process properties

Get rows from a user table

Get rows from a user table

Insert rows into a user table

Import table rows into a user table

List processes

List processes

Logoff

Logoff

Logon

Logon

Logon with hashed password

Logon with hashed password

Update document

Update document

Update process

Update process

Close an open process

Close an open process

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

The connection id to identify your connection

ProcessId
processId True string

Id of process (Guid)

Comment
comment string

Comment to add

Returns

Name Path Type Description
AccessRightsEnumList
CloseProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
CloseProcessResult.CheckOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
CloseProcessResult.CheckOutUserId string

Id of the user for which process is checked out

Comments
CloseProcessResult.Comments array of object

Comments

Date
CloseProcessResult.Comments.Date string

Date of comment

Id
CloseProcessResult.Comments.Id string

Id of comment

Text
CloseProcessResult.Comments.Text string

User defined comment

UserId
CloseProcessResult.Comments.UserId string

User id

CompletedDate
CloseProcessResult.CompletedDate string

Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss

CompletedTasks
CloseProcessResult.CompletedTasks array of object

CompletedTasks

Action
CloseProcessResult.CompletedTasks.Action string

Action text for the user

AssignedUserIds
CloseProcessResult.CompletedTasks.AssignedUserIds array of

AssignedUserIds

Comments
CloseProcessResult.CompletedTasks.Comments array of object

Comments

Date
CloseProcessResult.CompletedTasks.Comments.Date string

Date of comment

Id
CloseProcessResult.CompletedTasks.Comments.Id string

Id of comment

Text
CloseProcessResult.CompletedTasks.Comments.Text string

User defined comment

UserId
CloseProcessResult.CompletedTasks.Comments.UserId string

Id of user, who has set the comment

CompletedDate
CloseProcessResult.CompletedTasks.CompletedDate string

Completion date of completed task. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
CloseProcessResult.CompletedTasks.CompletedUserIds array of string

CompletedUserIds

CreatedDate
CloseProcessResult.CompletedTasks.CreatedDate string

Creation date of completed task. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CompletedTasks.CreatorId string

User id of the creator of completed task

Description
CloseProcessResult.CompletedTasks.Description string

Task description of completed task

DueDate
CloseProcessResult.CompletedTasks.DueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.CompletedTasks.Id string

Id of the task

IntendedUserIds
CloseProcessResult.CompletedTasks.IntendedUserIds array of

IntendedUserIds

ReminderDate
CloseProcessResult.CompletedTasks.ReminderDate string

Date for reminder of completed task. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CompletedTasks.RequiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

Show close task dialog at task end

StatusEnum
CloseProcessResult.CompletedTasks.StatusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
CloseProcessResult.CompletedTasks.TaskTemplateId string

Task template id

CreatedDate
CloseProcessResult.CreatedDate string

Creation date of the process Date format: yyyy-MM-ddTHH:mm:ss

Action
CloseProcessResult.CurrentTask.Action string

Action text for the user

AssignedUserIds
CloseProcessResult.CurrentTask.AssignedUserIds array of string

AssignedUserIds

Comments
CloseProcessResult.CurrentTask.Comments array of object

Comments

Date
CloseProcessResult.CurrentTask.Comments.Date string

Date of comment

Id
CloseProcessResult.CurrentTask.Comments.Id string

Id of comment

Text
CloseProcessResult.CurrentTask.Comments.Text string

User defined comment

UserId
CloseProcessResult.CurrentTask.Comments.UserId string

Id of user, who has set the comment

CompletedDate
CloseProcessResult.CurrentTask.CompletedDate string

Completion date of current task. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
CloseProcessResult.CurrentTask.CompletedUserIds array of string

CompletedUserIds

CreatedDate
CloseProcessResult.CurrentTask.CreatedDate string

Creation date of current task. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
CloseProcessResult.CurrentTask.CreatorId string

User id of the creator of current task

Description
CloseProcessResult.CurrentTask.Description string

Task description of current task

DueDate
CloseProcessResult.CurrentTask.DueDate string

Due date of the current task. Date format: yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.CurrentTask.Id string

Id of the current task

IntendedUserIds
CloseProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

ReminderDate
CloseProcessResult.CurrentTask.ReminderDate string

Date for reminder of current task. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
CloseProcessResult.CurrentTask.RequiresAllRecipients boolean

Defines if all recipients have to close the current task

ShowCloseTaskDialog
CloseProcessResult.CurrentTask.ShowCloseTaskDialog boolean

Show close task dialog at current task

StatusEnum
CloseProcessResult.CurrentTask.StatusEnum string

Status of current task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
CloseProcessResult.CurrentTask.TaskTemplateId string

Task template id of current task

CustomProperties
CloseProcessResult.CustomProperties array of object

CustomProperties

CustomPropertyTypeEnum
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum string

Custom property type enum value of custom property (String, Date, Number)

Name
CloseProcessResult.CustomProperties.Name string

Name of the custom property

Value
CloseProcessResult.CustomProperties.Value string

Value of the custom property

DocumentIds
CloseProcessResult.DocumentIds array of string

DocumentIds

DueDate
CloseProcessResult.DueDate string

Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss

Id
CloseProcessResult.Id string

Id of process

Values
CloseProcessResult.Name.Values array of object

Values

Culture
CloseProcessResult.Name.Values.Culture string

The culture in which the text is given (de, en, fr, ...)

Text
CloseProcessResult.Name.Values.Text string

Name of process

PluginStream
CloseProcessResult.PluginStream array of string

PluginStream

PriorityEnum
CloseProcessResult.PriorityEnum string

Priority of process (High, Normal, Low)

ProcessTemplateId
CloseProcessResult.ProcessTemplateId string

Process template id

Properties
CloseProcessResult.Properties array of object

Properties

GlobalValues
CloseProcessResult.Properties.GlobalValues array of object

GlobalValues

Values
CloseProcessResult.Properties.GlobalValues.Values array of object

Values

Culture
CloseProcessResult.Properties.GlobalValues.Values.Culture string

Culture

Text
CloseProcessResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
CloseProcessResult.Properties.PropertyTypeId string

Type id of the index field

Values
CloseProcessResult.Properties.Values array of string

Values

ProtectionDomainId
CloseProcessResult.ProtectionDomainId string

Protection domain id of process

SessionCount
CloseProcessResult.SessionCount integer

Session count

StatusEnum
CloseProcessResult.StatusEnum string

Status of process (Open, InProcess, Complete, PreparedToComplete, Error)

Close current task and assign user to next task

Close current task and assign user to next task

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

ProcessId
ProcessId True string

Id of process (Guid)

TaskId
TaskId string

Id of task (Guid)

Comment
Comment string

Comment

AssignUserLoginNames
AssignUserLoginNames True string

AssignUserLoginNames

Returns

Name Path Type Description
Action
action string

Action text for the user. Displayed to the end user

assignedUserIds
assignedUserIds array of string

assignedUserIds

comments
comments array of object

comments

Date
comments.date string

Date of comment

Id
comments.id string

Id of comment

Text
comments.text string

User defined comment

UserId
comments.userId string

Id of user, who has set the comment

CompletedDate
completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
CompletedUserIds array of string

CompletedUserIds

CreatedDate
createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
creatorId string

User id of the creator

Description
description string

Task description

DueDate
dueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

intendedUserIds
intendedUserIds array of string

intendedUserIds

ReminderDate
reminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
showCloseTaskDialog boolean

Show close task dialog at task end

Status
statusEnum string

Status of task Status (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
taskTemplateId string

Task template id

Close task and continue process

Close task and continue process

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

The connection id to identify your connection

ProcessId
processId True string

Id of process (Guid)

Comment
comment string

Comment to add

TaskId
taskId string

Task id

AssignUsers
assignUsers True boolean

Assign to users. If set to no, assign user with action Update process

Returns

Name Path Type Description
Action
action string

Action text for the user. Displayed to the end user

AssignedUserIds
assignedUserIds string

List of assigned user ids

comments
comments array of object

comments

Date
comments.date string

Date of comment

Id
comments.id string

Id of comment

Text
comments.text string

User defined comment

UserId
comments.userId string

User Id

CompletedDate
completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
completedUserIds string

List of all completed user ids

CreatedDate
createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
creatorId string

User id of the creator

Description
description string

Task description

DueDate
dueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

IntendedUserIds
intendedUserIds string

Intended users for this task

ReminderDate
reminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
showCloseTaskDialog boolean

Show close task dialog at task end

Status
statusEnum string

Status of task Status (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
taskTemplateId string

Task template id

Create a user table

Create a user table

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

UserTable
UserTable True string

Name of the user table (e.g.: Address)

ColumnHeaders
ColumnHeaders True string

A list of column headers (e.g.: Firstname,Lastname,City)

Returns

Name Path Type Description
User Table
userTable string

Name of user table

Create document

Create document

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

DocumentTitle
DocumentTitle True string

Title of document (incl. extension)

ImportTemplate
ImportTemplate True string

Import template

DocumentProperties
DocumentProperties string

Document properties insert format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713

Culture
Culture string

The culture in which the property names are given (de, en, fr, ...). Default = de

FileContent
FileContent True string

File content base64 string

Returns

Name Path Type Description
abonnements
abonnements array of string

abonnements

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postItAnnotations
annotationManager.postItAnnotations array of object

postItAnnotations

CreatedDate
annotationManager.postItAnnotations.createdDate string

Creation date from post it annotation

CreatorId
annotationManager.postItAnnotations.creatorId string

User id of creator from post it annotation

IsItalic
annotationManager.postItAnnotations.fontInfo.isItalic boolean

Is font italic from post it annotation

IsStrikeOut
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

Is Font strike out from post it annotation

IsUnderline
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

Is Font is underline from post it annotation

Name
annotationManager.postItAnnotations.fontInfo.name string

Font name from post it annotation. Default = Arial

Pitch
annotationManager.postItAnnotations.fontInfo.pitch integer

Font pitch from post it annotation

Size
annotationManager.postItAnnotations.fontInfo.size integer

Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

Font weight from post it annotation

Id
annotationManager.postItAnnotations.id string

Id of the post it annotation

ModifiedDate
annotationManager.postItAnnotations.modifiedDate string

Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.postItAnnotations.pageNumber integer

Number of page from post it annotation

SecurityLevelEnum
annotationManager.postItAnnotations.securityLevelEnum string

Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.postItAnnotations.selectable boolean

Defines if post it annotation is selectable by user

Text
annotationManager.postItAnnotations.text string

User defined text for post it annotation

X
annotationManager.postItAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI of post it annotation

Y
annotationManager.postItAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI of post it annotation

rectangleAnnotations
annotationManager.rectangleAnnotations array of object

rectangleAnnotations

Color
annotationManager.rectangleAnnotations.color integer

Color of rectangle (32 bit ARGB value) from rectangle annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ColorHexCode
annotationManager.rectangleAnnotations.colorHexCode string

Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

creatorId
annotationManager.rectangleAnnotations.creatorId string

CreatorId

Height
annotationManager.rectangleAnnotations.height integer

Height of rectangle in pixel per inch for 7200 DPI

Id
annotationManager.rectangleAnnotations.Id string

Id of the rectangle annotation

ModifiedDate
annotationManager.rectangleAnnotations.modifiedDate string

Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.rectangleAnnotations.pageNumber integer

Number of page from rectangle annotation

SecurityLevelEnum
annotationManager.rectangleAnnotations.securityLevelEnum string

Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.rectangleAnnotations.selectable boolean

Defines if rectangle annotation is selectable by user

Transparent
annotationManager.rectangleAnnotations.transparent boolean

Rectangle should be transparent (highlight)

Width
annotationManager.rectangleAnnotations.width integer

Width of rectangle in pixel per inch for 7200 DPI

X
annotationManager.rectangleAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI from rectangle annotation

Y
annotationManager.rectangleAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI from rectangle annotation

textAnnotations
annotationManager.textAnnotations array of object

textAnnotations

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

Color of background (32 bit ARGB value) from text annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

BackgroundColorHexCode
annotationManager.textAnnotations.backgroundColorHexCode string

Color of background (RGB hexadecimal code) from text annotation Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

User id of creator from text annotation

IsItalic
annotationManager.textAnnotations.fontInfo.isItalic boolean

Is Font italic from text annotation

IsStrikeOut
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

Is font strike out from text annotation

IsUnderline
annotationManager.textAnnotations.fontInfo.isUnderline boolean

Is font underline from text annotation

Name
annotationManager.textAnnotations.fontInfo.name string

Font name from text annotation. Default = Arial

Pitch
annotationManager.textAnnotations.fontInfo.pitch integer

Font pitch from text annotation

Size
annotationManager.textAnnotations.fontInfo.size integer

Font size from text annotation. Example: Size:12 is 12000. You need factor 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

Font weight from text annotation

ForegroundColor
annotationManager.textAnnotations.foregroundColor integer

Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ForegroundColorHexCode
annotationManager.textAnnotations.foregroundColorHexCode string

Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

Height
annotationManager.textAnnotations.height integer

Height of text in pixel per inch for 7200 DPI from text annotation

Id
annotationManager.textAnnotations.id string

Id of text annotation

ModifiedDate
annotationManager.textAnnotations.modifiedDate string

Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.textAnnotations.pageNumber integer

Number of page from text annotation

Rotation
annotationManager.textAnnotations.rotation integer

Rotation in degrees from text annotation

SecurityLevelEnum
annotationManager.textAnnotations.securityLevelEnum string

Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.textAnnotations.selectable boolean

Defines if text annotation is selectable by user

Text
annotationManager.textAnnotations.text string

User defined Text of text annotation

Transparent
annotationManager.textAnnotations.transparent boolean

Text annotation should be transparent

Width
annotationManager.textAnnotations.width integer

Width of text in pixel per inch for 7200 DPI from text annotation

X
annotationManager.textAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI from text annotation

Y
annotationManager.textAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI from text annotation

blogs
blogs array of object

blogs

Blogs
blogs object

List of all blog items

CheckOutState
checkOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

Id of the user for which document is checked out

documentData
documentData array of object

documentData

Id
documentData.id string

Id of document rendition

Name
documentData.name string

Document name of rendition

renditions
documentData.renditions array of object

renditions

contentProtections
documentData.renditions.contentProtections array of

contentProtections

extension
documentData.renditions.extension string

Extension of rendition

files
documentData.renditions.files array of object

files

blobPath
documentData.renditions.files.blobPath string

Blob path of rendition

blobStoreId
documentData.renditions.files.blobStoreId string

Blob store Id of rendition

id
documentData.renditions.id string

id

pageCount
documentData.renditions.pageCount string

Page count of rendition

size
documentData.renditions.size string

Size of rendition

HasOverlay
hasOverlay boolean

Defines if the document should be displayed with a overlay

Id
id string

Id of the document

ImportTemplateId
importTemplateId string

Id of the import template for this document

InfoStoreId
infoStoreId string

Id of the info store

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Checkout life cycle state

LifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

Id of the LifeCycle state

NextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Next automatic life cycle state

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycleStates

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

lifeCycleProtections

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Allow to delete document after protection expiration

Id
lifeCycleManager.lifeCycleProtections.id string

Id of life cycle state protection

ProtectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Protect against annotation changes

ProtectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Protect against check out

ProtectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Protect against content change

ProtectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Protect against delete

ProtectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Protect against property changes

ProtectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Protect against security change

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Duration of protection

LifeCycleId
lifeCycleManager.lifeCycleId string

Id of the LifeCycle

MainFileLength
mainFileLength integer

Main file size

Name
name string

Name of the document

PageCount
pageCount integer

Page count of main file

properties
properties array of object

properties

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

culture
properties.globalValues.values.culture string

Culture

text
properties.globalValues.values.text string

Text

PropertyTypeId
properties.propertyTypeId string

Type id of the index field

values
properties.values array of string

values

ProtectionDomainId
protectionDomainId string

Id of the protection domain

reminders
reminders array of object

reminders

Reminders
reminders object

List of all reminders

SessionCount
sessionCount integer

Session count

SigningProfileId
signingProfileId string

Id of the signing profile

VersionId
versionId string

Version id of the document

Create process

Create process

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

ProcessProperties
ProcessProperties string

Process properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713

CustomProperties
CustomProperties string

Custom properties. Format: [||PropertyType] (e.g. [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Number])

DocumentIds
DocumentIds string

List of all document Ids to attach

ProcessTemplateName
ProcessTemplateName True string

Name of process template

DueDate
DueDate string

Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss. Default = current date

Priority
Priority string

Priority of process (e.g. Low, Normal, High). Default = Normal

Comment
Comment string

Process comment

Culture
Culture string

The culture in which the text is given (de, en, fr, ...). Default = de

Returns

Name Path Type Description
accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

CheckOutState
checkOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

Id of the user for which process is checked out

comments
comments array of object

comments

Date
comments.date string

Date of comment

Id
comments.id string

Id of comment

Text
comments.text string

User defined comment

UserId
comments.userId string

User Id

CompletedDate
completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

completedTasks
completedTasks array of string

completedTasks

CreatedDate
createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

Action
currentTask.action string

Action text for the user. Displayed to the end user

assignedUserIds
currentTask.assignedUserIds array of string

assignedUserIds

comments
currentTask.comments array of string

comments

CompletedDate
currentTask.completedDate string

Completion date for current task. Date format: yyyy-MM-ddTHH:mm:ss

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

CreatedDate
currentTask.createdDate string

Creation date for current task. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
currentTask.creatorId string

User id of creator for current task

Description
currentTask.description string

Description of current task

DueDate
currentTask.dueDate string

Due date of current task. Date format: yyyy-MM-ddTHH:mm:ss

intendedUserIds
currentTask.intendedUserIds array of string

intendedUserIds

ReminderDate
currentTask.reminderDate string

Date for reminder of current task. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
currentTask.requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
currentTask.showCloseTaskDialog boolean

Show close task dialog at task end

StatusEnum
currentTask.statusEnum string

Status current task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
currentTask.taskTemplateId string

Template id of current task

customProperties
customProperties array of object

customProperties

CustomPropertyTypeEnum
customProperties.customPropertyTypeEnum string

Custom property type enum value (String, Date, Number)

Name
customProperties.name string

Name of custom property

Value
customProperties.value string

Value of custom property

documentIds
documentIds array of string

documentIds

DueDate
dueDate string

Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss

FolderElementId
folderElementId string

Id of document as folder element

HasLinks
hasLinks boolean

Id of document as folder element

Id
id string

Process id

values
name.values array of object

values

Culture
name.values.culture string

The culture in which the text is given (de, en, fr, ...)

Text
name.values.text string

The text for this language

PriorityEnum
priorityEnum string

Priority of process (High, Normal, Low). Default = Normal

PluginStream
pluginStream string

Data container for plugins

ProcessTemplateId
processTemplateId string

Process template id

properties
properties array of object

properties

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

culture
properties.globalValues.values.culture string

culture

text
properties.globalValues.values.text string

text

PropertyName
properties.propertyName string

Name of process property

PropertyTypeId
properties.propertyTypeId string

Id of process property

values
properties.values array of string

values

ProtectionDomainId
protectionDomainId string

Protection domain id of process

StatusEnum
statusEnum string

Status of process (Open, InProcess, Complete, PreparedToComplete, Error)

Delete user table rows

Delete user table rows

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

UserTable
UserTable True string

Name of user table

WhereClause
WhereClause string

A list of SQL where clause elements. Format: [|||]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (e.g.: [Firstname|Equals|Jon|AND],[Lastname|Equals|Doe|OR])

Returns

Name Path Type Description
userTableDeleteRecordsResult
userTableDeleteRecordsResult integer

userTableDeleteRecordsResult

Document Search

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

Conditions
Conditions string

Search condition format: [|||]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". e.g.: [Last check in|Less|2021-12-31|And],[Firstname|Equals|Peter|And]

Culture
Culture string

Culture (de,en,fr,...). Default = de

FulltextWords
FulltextWords string

Words to be searcheds with fulltext

FulltextWordRelation
FulltextWordRelation string

Fulltext word relation (AND, OR). Default = AND

MaxSerchResults
MaxSerchResults string

Maximum number of document search results. Default = 100

Returns

Name Path Type Description
documents
documents array of object

documents

Abonnements
documents.abonnements string

List of abonnements

accessRightsEnumList
documents.accessRightsEnumList array of string

accessRightsEnumList

AnnotationManager
documents.annotationManager string

Annotations for main document file

Blogs
documents.blogs string

List of all blog items

CheckOutState
documents.checkOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
documents.checkOutUserId string

Id of the user for which document is checked out

DocumentData
documents.documentData string

Document data list

HasOverlay
documents.hasOverlay boolean

Defines if the document should be displayed with a overlay

Id
documents.id string

Id of the document

ImportTemplateId
documents.importTemplateId string

Id of the import template for this document

InfoStoreId
documents.infoStoreId string

Id of the info store

LifeCycleManager
documents.lifeCycleManager string

Life cycle informations

MainFileLength
documents.mainFileLength integer

Main file size

Name
documents.name string

Name of the document

PageCount
documents.pageCount integer

Page count of main file

properties
documents.properties array of

properties

ProtectionDomainId
documents.protectionDomainId string

Id of the protection domain

Reminders
documents.reminders string

List of all reminders

SessionCount
documents.sessionCount integer

Session count

SigningProfileId
documents.signingProfileId string

Id of the signing profile

VersionId
documents.versionId string

Version id of the document

HasMore
hasMore boolean

Indicates, whether more results exists or not. The flag is set to true if more results are available

ResumePoint
resumePoint string

The resume point from previous search operation. Set null for the first search operation

Get document

Get document

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

The connection id to identify your connection

DocumentId
documentId True string

The document id

Returns

Name Path Type Description
Abonnements
GetDocumentResult.Abonnements array of object

Abonnements

OnContentChange
GetDocumentResult.Abonnements.OnContentChange boolean

Abonnement is active on file changes

OnDelete
GetDocumentResult.Abonnements.OnDelete boolean

Abonnement is active on delete

OnMetadataChange
GetDocumentResult.Abonnements.OnMetadataChange boolean

Abonnement is active on index changes

UserId
GetDocumentResult.Abonnements.UserId string

The user id for this abonnnement

AccessRightsEnumList
GetDocumentResult.AccessRightsEnumList array of string

accessRightsEnumList

PostItAnnotations
GetDocumentResult.AnnotationManager.PostItAnnotations array of object

PostItAnnotations

CreatedDate
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate string

Creation date from post it annotation

CreatorId
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId string

User id of creator from post it annotation

IsItalic
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic boolean

Is font italic from post it annotation

IsStrikeOut
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut boolean

Is Font strike out from post it annotation

IsUnderline
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline boolean

Is Font is underline from post it annotation

Name
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name string

Font name from post it annotation. Default = Arial

Pitch
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch integer

Font pitch from post it annotation

Size
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size integer

Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000

Weight
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight integer

Font weight from post it annotation

Id
GetDocumentResult.AnnotationManager.PostItAnnotations.Id string

Id of the post it annotation

ModifiedDate
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate string

Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber integer

Number of page from post it annotation

SecurityLevelEnum
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum string

Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable boolean

Defines if post it annotation is selectable by user

Text
GetDocumentResult.AnnotationManager.PostItAnnotations.Text string

User defined text for post it annotation

X
GetDocumentResult.AnnotationManager.PostItAnnotations.X integer

X coordinate in pixel per inch for 7200 DPI of post it annotation

Y
GetDocumentResult.AnnotationManager.PostItAnnotations.Y integer

Y coordinate in pixel per inch for 7200 DPI of post it annotation

RectangleAnnotations
GetDocumentResult.AnnotationManager.RectangleAnnotations array of object

RectangleAnnotations

Color
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color integer

Color of rectangle (32 bit ARGB value) from rectangle annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ColorHexCode
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode string

Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate string

Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId string

CreatorId

Height
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height integer

Height of rectangle in pixel per inch for 7200 DPI

Id
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id string

Id of the rectangle annotation

ModifiedDate
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate string

Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber integer

Number of page from rectangle annotation

SecurityLevelEnum
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum string

Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable boolean

Defines if rectangle annotation is selectable by user

Transparent
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent boolean

Rectangle should be transparent (highlight)

Width
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width integer

Width of rectangle in pixel per inch for 7200 DPI

X
GetDocumentResult.AnnotationManager.RectangleAnnotations.X integer

X coordinate in pixel per inch for 7200 DPI from rectangle annotation

Y
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y integer

Y coordinate in pixel per inch for 7200 DPI from rectangle annotation

TextAnnotations
GetDocumentResult.AnnotationManager.TextAnnotations array of object

TextAnnotations

BackgroundColor
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor integer

Color of background (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

BackgroundColorHexCode
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode string

Color of background (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate string

creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId string

User id of creator from text annotation

IsItalic
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic boolean

Is Font italic from text annotation

IsStrikeOut
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut boolean

Is font strike out from text annotation

IsUnderline
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline boolean

Is font underline from text annotation

Name
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name string

Font name from text annotation. Default = Arial

Pitch
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch integer

Font pitch from text annotation

Size
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size integer

Font size from text annotation.. Example: Size:12 is 12000. You need factor 1000

Weight
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight integer

Font weight from text annotation

ForegroundColor
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor integer

Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ForegroundColorHexCode
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode string

Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

Height
GetDocumentResult.AnnotationManager.TextAnnotations.Height integer

Height of text in pixel per inch for 7200 DPI from text annotation

Id
GetDocumentResult.AnnotationManager.TextAnnotations.Id string

Id of text annotation

ModifiedDate
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate string

Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber integer

Number of page from text annotation

Rotation
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation integer

Rotation in degrees from text annotation

SecurityLevelEnum
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum string

Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable boolean

Defines if text annotation is selectable by user

Text
GetDocumentResult.AnnotationManager.TextAnnotations.Text string

User defined Text of text annotation

Transparent
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent boolean

Text annotation should be transparent

Width
GetDocumentResult.AnnotationManager.TextAnnotations.Width integer

Width of text in pixel per inch for 7200 DPI from text annotation

X
GetDocumentResult.AnnotationManager.TextAnnotations.X integer

X coordinate in pixel per inch for 7200 DPI from text annotation

Y
GetDocumentResult.AnnotationManager.TextAnnotations.Y integer

Y coordinate in pixel per inch for 7200 DPI from text annotation

Blogs
GetDocumentResult.Blogs array of object

Blogs

CreatedDate
GetDocumentResult.Blogs.CreatedDate string

Date on which the Blog was created. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
GetDocumentResult.Blogs.CreatorId string

User Id of the creating user blog

Id
GetDocumentResult.Blogs.Id string

Id of the blog

Text
GetDocumentResult.Blogs.Text string

Text of blog item

CheckOutStateEnum
GetDocumentResult.CheckOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
GetDocumentResult.CheckOutUserId string

Id of the user for which document is checked out

DocumentData
GetDocumentResult.DocumentData array of object

DocumentData

Id
GetDocumentResult.DocumentData.Id string

Id of document rendition

Name
GetDocumentResult.DocumentData.Name string

Document name of rendition

Renditions
GetDocumentResult.DocumentData.Renditions array of object

Renditions

ContentProtections
GetDocumentResult.DocumentData.Renditions.ContentProtections array of

ContentProtections

Extension
GetDocumentResult.DocumentData.Renditions.Extension string

Extension

Files
GetDocumentResult.DocumentData.Renditions.Files array of object

Files

BlobPath
GetDocumentResult.DocumentData.Renditions.Files.BlobPath string

BlobPath

BlobStoreId
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId string

BlobStoreId

HashValue
GetDocumentResult.DocumentData.Renditions.HashValue array of integer

HashValue

Id
GetDocumentResult.DocumentData.Renditions.Id string

Id

PageCount
GetDocumentResult.DocumentData.Renditions.PageCount integer

PageCount

Size
GetDocumentResult.DocumentData.Renditions.Size integer

Size

HasOverlay
GetDocumentResult.HasOverlay boolean

Defines if the document should be displayed with a overlay

Id
GetDocumentResult.Id string

Id of the document

ImportTemplateId
GetDocumentResult.ImportTemplateId string

Id of the import template for this document

InfoStoreId
GetDocumentResult.InfoStoreId string

Id of the info store

CheckOutLifeCycleStateId
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId string

Checkout life cycle state

LifeCycleEndDate
GetDocumentResult.LifeCycleManager.LifeCycleEndDate string

Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStartDate
GetDocumentResult.LifeCycleManager.LifeCycleStartDate string

Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
GetDocumentResult.LifeCycleManager.LifeCycleStateId string

Id of the LifeCycle state

NextAutomaticLifeCycleStateId
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId string

Next automatic life cycle state

NextLifeCycleStates
GetDocumentResult.LifeCycleManager.NextLifeCycleStates array of string

NextLifeCycleStates

LifeCycleProtections
GetDocumentResult.LifeCycleManager.LifeCycleProtections array of object

LifeCycleProtections

DeleteAfterExpiration
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration boolean

Allow to delete document after protection expiration

Id
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id string

Id of life cycle state protection

ProtectAnnotationChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange boolean

Protect against annotation changes

ProtectCheckOut
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut boolean

Protect against check out

ProtectContentChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange boolean

Protect against content change

ProtectDelete
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete boolean

Protect against delete

ProtectPropertyChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange boolean

Protect against property changes

ProtectProtectionDomainChange
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange boolean

Protect against security change

ProtectionDurationTicks
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks integer

Duration of protection

LifeCycleId
GetDocumentResult.LifeCycleManager.LifeCycleId string

Id of the LifeCycle

MainFileLength
GetDocumentResult.MainFileLength integer

Main file size

Name
GetDocumentResult.Name string

Name of the document

PageCount
GetDocumentResult.PageCount integer

Page count of main file

Properties
GetDocumentResult.Properties array of object

Properties

GlobalValues
GetDocumentResult.Properties.GlobalValues array of object

GlobalValues

Values
GetDocumentResult.Properties.GlobalValues.Values array of object

Values

Culture
GetDocumentResult.Properties.GlobalValues.Values.Culture string

Culture

Text
GetDocumentResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
GetDocumentResult.Properties.PropertyTypeId string

Type id of the index field

Values
GetDocumentResult.Properties.Values array of string

Values

ProtectionDomainId
GetDocumentResult.ProtectionDomainId string

Id of the protection domain

Reminders
GetDocumentResult.Reminders array of object

Reminders

Description
GetDocumentResult.Reminders.Description string

Description for reminder

Interval
GetDocumentResult.Reminders.Interval integer

Interval in days between reminders

ProcessTemplateId
GetDocumentResult.Reminders.ProcessTemplateId string

Process template Id for this reminder

ReminderDate
GetDocumentResult.Reminders.ReminderDate string

Date of the reminder. Date format: yyyy-MM-ddTHH:mm:ss

ReminderId
GetDocumentResult.Reminders.ReminderId string

Id of the reminder

SubjectIds
GetDocumentResult.Reminders.SubjectIds array of

subjectIds

UseUserFromProcessTemplate
GetDocumentResult.Reminders.UseUserFromProcessTemplate boolean

Defines if the user definition from process template will be used

SessionCount
GetDocumentResult.SessionCount integer

Session count

SigningProfileId
GetDocumentResult.SigningProfileId string

Id of the signing profile

VersionId
GetDocumentResult.VersionId string

Version id of the document

Get document properties

Get document properties

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

DocumentId
DocumentId True string

Id of document

Culture
Culture string

The culture in which the property names are given (de, en, fr, ...). Default = de

Returns

Name Path Type Description
array of object
globalValues
globalValues array of object

globalValues

values
globalValues.values array of object

values

culture
globalValues.values.culture string

Culture

text
globalValues.values.text string

Text

PropertyName
propertyName string

Name of property

PropertyTypeId
propertyTypeId string

Type id of the index field

values
values array of string

values

Get file content

Get file content

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

DocumentId
DocumentId True string

Id of document

VersionId
VersionId string

Id of version (Guid)

DocumentDataId
DocumentDataId string

Id of document data (Guid)

RenditionId
RenditionId string

Id of document rendition (Guid)

IgnoreHashValidation
IgnoreHashValidation boolean

Ignore system configuration for hash validation. Default = yes

Returns

File Content

File Content
string

Get file content converted

Convert file content to different format. Add annotation or overlay to file content

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

DocumentId
DocumentId True string

Id of document

VersionId
VersionId string

Id of version (Guid)Id of version (Guid)

DocumentDataId
DocumentDataId string

Id of document data (Guid)

RenditionId
RenditionId string

Id of document rendition (Guid)

TargetFormat
TargetFormat string

The target format (e.g. "png;pdf;tif;...")

AddAnnotatins
AddAnnotatins boolean

Defines if document should be exported with annotations. Default = yes

AddOverlay
AddOverlay boolean

Defines if document should be exported with overlays. Default = yes

Returns

File content converted

File Content
string

Get process

Get Process

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
connectionId True string

The connection id to identify your connection

ProcessId
processId True string

Id of process (Guid)

Returns

Name Path Type Description
AccessRightsEnumList
GetProcessResult.AccessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
GetProcessResult.CheckOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
GetProcessResult.CheckOutUserId string

Id of the user for which process is checked out

Comments
GetProcessResult.Comments array of object

Comments

Date
GetProcessResult.Comments.Date string

Date of comment

Id
GetProcessResult.Comments.Id string

Id of comment

Text
GetProcessResult.Comments.Text string

User defined comment

UserId
GetProcessResult.Comments.UserId string

Id of user, who has set the comment

CompletedDate
GetProcessResult.CompletedDate string

Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss

CompletedTasks
GetProcessResult.CompletedTasks array of object

CompletedTasks

Action
GetProcessResult.CompletedTasks.Action string

Action text for the user. Displayed to the end user

AssignedUserIds
GetProcessResult.CompletedTasks.AssignedUserIds array of

assignedUserIds

Comments
GetProcessResult.CompletedTasks.Comments array of object

Comments

Date
GetProcessResult.CompletedTasks.Comments.Date string

Date of comment

Id
GetProcessResult.CompletedTasks.Comments.Id string

Id of comment

Text
GetProcessResult.CompletedTasks.Comments.Text string

User defined comment

UserId
GetProcessResult.CompletedTasks.Comments.UserId string

Id of user, who has set the comment

CompletedDate
GetProcessResult.CompletedTasks.CompletedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
GetProcessResult.CompletedTasks.CompletedUserIds array of string

completedUserIds

CreatedDate
GetProcessResult.CompletedTasks.CreatedDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CompletedTasks.CreatorId string

User id of the creator

Description
GetProcessResult.CompletedTasks.Description string

Task description

DueDate
GetProcessResult.CompletedTasks.DueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

IntendedUserIds
GetProcessResult.CompletedTasks.IntendedUserIds array of

intendedUserIds

ReminderDate
GetProcessResult.CompletedTasks.ReminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CompletedTasks.RequiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
GetProcessResult.CompletedTasks.ShowCloseTaskDialog boolean

Show close task dialog at task end

Status
GetProcessResult.CompletedTasks.StatusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
GetProcessResult.CompletedTasks.TaskTemplateId string

Task template id

CreatedDate
GetProcessResult.CreatedDate string

Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss

Action
GetProcessResult.CurrentTask.Action string

Action text for the user. Displayed to the end user

AssignedUserIds
GetProcessResult.CurrentTask.AssignedUserIds array of string

AssignedUserIds

Comments
GetProcessResult.CurrentTask.Comments array of string

Comments

CompletedDate
GetProcessResult.CurrentTask.CompletedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

CompletedUserIds
GetProcessResult.CurrentTask.CompletedUserIds array of string

CompletedUserIds

CreatedDate
GetProcessResult.CurrentTask.CreatedDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
GetProcessResult.CurrentTask.CreatorId string

User id of the creator

Description
GetProcessResult.CurrentTask.Description string

Task description

DueDate
GetProcessResult.CurrentTask.DueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

Id
GetProcessResult.CurrentTask.Id string

Id of the task

IntendedUserIds
GetProcessResult.CurrentTask.IntendedUserIds array of string

IntendedUserIds

ReminderDate
GetProcessResult.CurrentTask.ReminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
GetProcessResult.CurrentTask.RequiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
GetProcessResult.CurrentTask.ShowCloseTaskDialog boolean

Show close task dialog at task end

StatusEnum
GetProcessResult.CurrentTask.StatusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
GetProcessResult.CurrentTask.TaskTemplateId string

Task template id

CustomProperties
GetProcessResult.CustomProperties array of object

CustomProperties

CustomPropertyTypeEnum
GetProcessResult.CustomProperties.CustomPropertyTypeEnum string

List of custom property data type (String, Date, Number)

Name
GetProcessResult.CustomProperties.Name string

Name of custom property type

Value
GetProcessResult.CustomProperties.Value string

Value of custom property type

DocumentIds
GetProcessResult.DocumentIds array of string

DocumentIds

DueDate
GetProcessResult.DueDate string

Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss

Id
GetProcessResult.Id string

Id of process

Values
GetProcessResult.Name.Values array of object

Values

Culture
GetProcessResult.Name.Values.Culture string

The culture in which the text is given (de, en, fr, ...)

Text
GetProcessResult.Name.Values.Text string

Text

PluginStream
GetProcessResult.PluginStream array of string

PluginStream

PriorityEnum
GetProcessResult.PriorityEnum string

Priority of process (High, Normal, Low)

ProcessTemplateId
GetProcessResult.ProcessTemplateId string

Process template id

Properties
GetProcessResult.Properties array of object

Properties

GlobalValues
GetProcessResult.Properties.GlobalValues array of object

GlobalValues

Values
GetProcessResult.Properties.GlobalValues.Values array of object

Values

Culture
GetProcessResult.Properties.GlobalValues.Values.Culture string

Culture

Text
GetProcessResult.Properties.GlobalValues.Values.Text string

Text

PropertyTypeId
GetProcessResult.Properties.PropertyTypeId string

Property type id

Values
GetProcessResult.Properties.Values array of string

Values

ProtectionDomainId
GetProcessResult.ProtectionDomainId string

Protection domain id of process

SessionCount
GetProcessResult.SessionCount integer

Session count

StatusEnum
GetProcessResult.StatusEnum string

Status of process (Open, InProcess, Complete, PreparedToComplete, Error)

Get process properties

Get process properties

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

ProcessId
ProcessId True string

Id of process (Guid)

Culture
Culture string

The culture in which the property names are given (de, en, fr, ...). Default = de

Returns

Name Path Type Description
array of object
PropertyName
propertyName string

Process property name

PropertyTypeId
propertyTypeId string

Property type id

values
values array of string

values

Get rows from a user table

Get rows from a user table

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

UserTable
UserTable True string

Name of the user table

WhereClause
WhereClause string

A list of SQL where clause elements. Format: [|||]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (e.g.: [Firstname|Equals|Jon|AND],[Lastname|Equals|Doe|AND])

OrderByClause
OrderByClause string

A list of SQL order by clause elements (e.g.: Firstname[ASC],City[DESC])

AddColumnHeaders
AddColumnHeaders boolean

Adds column headers as first row (default = false)

Returns

Name Path Type Description
UserTableGetRecordsResult
UserTableGetRecordsResult array of array

UserTableGetRecordsResult

items
UserTableGetRecordsResult array of string

Insert rows into a user table

Import table rows into a user table

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

UserTable
UserTable True string

Name of the user table

Values
Values True string

List of row and column values to insert (e.g.: [John;Doe;New York],[Peter;Muster;Bern])

DeleteAllValues
DeleteAllValues boolean

Defines whether to delete all values in UserTable (default = false)

FirstRowContainsColumnHeaders
FirstRowContainsColumnHeaders boolean

Defines whether the first row of the values parameter contains column headers (default = false)

Returns

Name Path Type Description
User Table
userTable string

Name of user table

Inserted Rows
insertedRows integer

Number of inserted rows

List processes

List processes

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

Receiver
Receiver string

Login names of receivers from processes (e.g.: john@sample.com|megan@sample.com). Is empty, logged in user will be taken as receiver

Status
Status string

Status of process. Default = open

IgnoreReceiver
IgnoreReceiver boolean

If yes, all processes indipendent of receiver are listed. Default = false

MaxSerchResults
MaxSerchResults string

Maximum number of process search results. Default = 100

Returns

Name Path Type Description
processes
processes array of object

processes

accessRightsEnumList
processes.accessRightsEnumList array of string

accessRightsEnumList

CheckOutStateEnum
processes.checkOutStateEnum string

Check out state of the process (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
processes.checkOutUserId string

Id of the user for which document is checked out

comments
processes.comments array of object

comments

Date
processes.comments.date string

Date of comment

Id
processes.comments.id string

Id of comment

Text
processes.comments.text string

User defined comment

UserId
processes.comments.userId string

Id of user, who has set the comment

CompletedDate
processes.completedDate string

Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss

completedTasks
processes.completedTasks array of object

completedTasks

Action
processes.completedTasks.action string

Action text for the user. Displayed to the end user

assignedUserIds
processes.completedTasks.assignedUserIds array of

assignedUserIds

comments
processes.completedTasks.comments array of object

comments

Date
processes.completedTasks.comments.date string

Date of comment

Id
processes.completedTasks.comments.id string

Id of comment

Text
processes.completedTasks.comments.text string

User defined comment

UserId
processes.completedTasks.comments.userId string

Id of user, who has set the comment

CompletedDate
processes.completedTasks.completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

completedUserIds
processes.completedTasks.completedUserIds array of string

completedUserIds

CreatedDate
processes.completedTasks.createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
processes.completedTasks.creatorId string

User id of the creator

Description
processes.completedTasks.description string

Task description

DueDate
processes.completedTasks.dueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

intendedUserIds
processes.completedTasks.intendedUserIds array of

intendedUserIds

ReminderDate
processes.completedTasks.reminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
processes.completedTasks.requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
processes.completedTasks.showCloseTaskDialog boolean

Show close task dialog at task end

Status
processes.completedTasks.statusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
processes.completedTasks.taskTemplateId string

Task template id

CreatedDate
processes.createdDate string

Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss

CurrentTask
processes.currentTask string

Currently active task

CustomProperties
processes.customProperties string

List of all custom properties

DocumentIds
processes.documentIds string

List of all attached document ids

DueDate
processes.dueDate string

Due date for the process Date format: yyyy-MM-ddTHH:mm:ss

FolderElementId
processes.folderElementId string

Id of process as folder element

HasLinks
processes.hasLinks boolean

Flag whether the process has links

Id
processes.id string

Id of process

values
processes.name.values array of object

values

culture
processes.name.values.culture string

culture

text
processes.name.values.text string

text

PriorityEnum
processes.priorityEnum string

Priority of process (High, Normal, Low)

PluginStream
processes.pluginStream string

Data container for plugins

ProcessTemplateId
processes.processTemplateId string

Process template id

properties
processes.properties array of object

properties

propertyName
processes.properties.propertyName string

propertyName

propertyTypeId
processes.properties.propertyTypeId string

propertyTypeId

values
processes.properties.values array of string

values

ProtectionDomainId
processes.protectionDomainId string

Protection domain id of process

StatusEnum
processes.statusEnum string

Status of process (Open, InProcess, Complete, PreparedToComplete, Error)

HasMore
hasMore boolean

Indicates, whether more results exists or not. The flag is set to true if more results are available

ResumePoint
resumePoint string

The resume point from previous search operations. Set null for the first search operation

Logoff

Logoff

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

Returns

Name Path Type Description
LogoffResult
LogoffResult string

Result of logoff

Logon

Logon

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

User name
Username True string

User name for logon

Password
Password True string

Password

Tenant name
Tenantname string

Tenant name to logon to

Returns

Name Path Type Description
ConnectionId
connectionId string

Contains the connection id if successfully logged in

ConnectionTimeoutSeconds
connectionTimeoutSeconds integer

Timeout for connection

IsApplicationLicence
isApplicationLicence string

Is application license type

IsConcurrentLicence
isConcurrentLicence string

Is concurrent licence type

IsNamedLicence
isNamedLicence string

Is named license typ

IsVerificationCodeNeeded
isVerificationCodeNeeded string

Is verification code needed

PossibleTwoWayAuthenticationType
possibleTwoWayAuthenticationType string

Possible two way authentication type (None, Mail, SMS)

TwoWayAuthenticationTargetMail
twoWayAuthenticationTargetMail string

The masked mail address where twoWayAuthentication will send mail to

Logon with hashed password

Logon with hashed password

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

User name
userName True string

User name for logon

Hashed password
passwordHashed True string

User password for logon (Base64 encoded SHA 512 Hash)

Tenant name
tenantName string

Tenant name to logon to

Returns

Name Path Type Description
ConnectionId
LogonResult.ConnectionId string

The connection id to identify your connection

ConnectionTimeoutSeconds
LogonResult.ConnectionTimeoutSeconds integer

Connection timeout in seconds

IsApplicationLicence
LogonResult.IsApplicationLicence boolean

Is application license type

IsConcurrentLicence
LogonResult.IsConcurrentLicence boolean

Is concurrent licence type

IsNamedLicence
LogonResult.IsNamedLicence boolean

Is named license type

IsVerificationCodeNeeded
LogonResult.IsVerificationCodeNeeded boolean

Is verification code needed

JWTToken
LogonResult.JWTToken string

The JWT token for this connection

PossibleTwoWayAuthenticationType
LogonResult.PossibleTwoWayAuthenticationType string

Possible two way authentication type (None, Mail, SMS)

TwoWayAuthenticationTargetMail
LogonResult.TwoWayAuthenticationTargetMail string

The masked mail address where twoWayAuthentication will send mail to

Update document

Update document

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

DocumentId
DocumentId True string

Id of document

DocumentTitle
DocumentTitle string

Title of document

DocumentProperties
DocumentProperties string

Document properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713

Culture
Culture string

The culture in which the text is given (de, en, fr, ...). Default = de

FileContent
FileContent string

File content base64 string

Returns

Name Path Type Description
abonnements
abonnements array of object

abonnements

OnContentChange
abonnements.onContentChange boolean

Abonnement is active on file changes

OnDelete
abonnements.onDelete boolean

Abonnement is active on delete

OnMetadataChange
abonnements.onMetadataChange boolean

Abonnement is active on index changes

UserId
abonnements.userId string

The user id for this abonnnement

accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

postItAnnotations
annotationManager.postItAnnotations array of object

postItAnnotations

CreatedDate
annotationManager.postItAnnotations.createdDate string

Creation date from post it annotation

CreatorId
annotationManager.postItAnnotations.creatorId string

User id of creator from post it annotation

IsItalic
annotationManager.postItAnnotations.fontInfo.isItalic boolean

Is font italic from post it annotation

IsStrikeOut
annotationManager.postItAnnotations.fontInfo.isStrikeOut boolean

Is Font strike out from post it annotation

IsUnderline
annotationManager.postItAnnotations.fontInfo.isUnderline boolean

Is Font is underline from post it annotation

Name
annotationManager.postItAnnotations.fontInfo.name string

Font name from post it annotation. Default = Arial

Pitch
annotationManager.postItAnnotations.fontInfo.pitch integer

Font pitch from post it annotation

Size
annotationManager.postItAnnotations.fontInfo.size integer

Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000

Weight
annotationManager.postItAnnotations.fontInfo.weight integer

Font weight from post it annotation

Id
annotationManager.postItAnnotations.id string

Id of the post it annotation

ModifiedDate
annotationManager.postItAnnotations.modifiedDate string

Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.postItAnnotations.pageNumber integer

Number of page from post it annotation

SecurityLevelEnum
annotationManager.postItAnnotations.securityLevelEnum string

Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.postItAnnotations.selectable boolean

Defines if post it annotation is selectable by user

Text
annotationManager.postItAnnotations.text string

User defined text for post it annotation

X
annotationManager.postItAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI of post it annotation

Y
annotationManager.postItAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI of post it annotation

rectangleAnnotations
annotationManager.rectangleAnnotations array of object

rectangleAnnotations

Color
annotationManager.rectangleAnnotations.color integer

Color of rectangle (32 bit ARGB value) from rectangle annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ColorHexCode
annotationManager.rectangleAnnotations.colorHexCode string

Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
annotationManager.rectangleAnnotations.createdDate string

Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

creatorId
annotationManager.rectangleAnnotations.creatorId string

CreatorId

Height
annotationManager.rectangleAnnotations.height integer

Height of rectangle in pixel per inch for 7200 DPI

Id
annotationManager.rectangleAnnotations.Id string

Id of the rectangle annotation

ModifiedDate
annotationManager.rectangleAnnotations.modifiedDate string

Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.rectangleAnnotations.pageNumber integer

Number of page from rectangle annotation

SecurityLevelEnum
annotationManager.rectangleAnnotations.securityLevelEnum string

Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.rectangleAnnotations.selectable boolean

Defines if rectangle annotation is selectable by user

Transparent
annotationManager.rectangleAnnotations.transparent boolean

Rectangle should be transparent (highlight)

Width
annotationManager.rectangleAnnotations.width integer

Width of rectangle in pixel per inch for 7200 DPI

X
annotationManager.rectangleAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI from rectangle annotation

Y
annotationManager.rectangleAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI from rectangle annotation

textAnnotations
annotationManager.textAnnotations array of object

textAnnotations

BackgroundColor
annotationManager.textAnnotations.backgroundColor integer

Color of background (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

BackgroundColorHexCode
annotationManager.textAnnotations.backgroundColorHexCode string

Color of background (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

CreatedDate
annotationManager.textAnnotations.createdDate string

creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
annotationManager.textAnnotations.creatorId string

User id of creator from text annotation

IsItalic
annotationManager.textAnnotations.fontInfo.isItalic boolean

Is Font italic from text annotation

IsStrikeOut
annotationManager.textAnnotations.fontInfo.isStrikeOut boolean

Is font strike out from text annotation

IsUnderline
annotationManager.textAnnotations.fontInfo.isUnderline boolean

Is font underline from text annotation

Name
annotationManager.textAnnotations.fontInfo.name string

Font name from text annotation. Default = Arial

Pitch
annotationManager.textAnnotations.fontInfo.pitch integer

Font pitch from text annotation

Size
annotationManager.textAnnotations.fontInfo.size integer

Font size from text annotation. Example: Size:12 is 12000. You need factor 1000

Weight
annotationManager.textAnnotations.fontInfo.weight integer

Font weight from text annotation

ForegroundColor
annotationManager.textAnnotations.foregroundColor integer

Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961

ForegroundColorHexCode
annotationManager.textAnnotations.foregroundColorHexCode string

Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF

Height
annotationManager.textAnnotations.height integer

Height of text in pixel per inch for 7200 DPI from text annotation

Id
annotationManager.textAnnotations.id string

Id of text annotation

ModifiedDate
annotationManager.textAnnotations.modifiedDate string

Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss

PageNumber
annotationManager.textAnnotations.pageNumber integer

Number of page from text annotation

Rotation
annotationManager.textAnnotations.rotation integer

Rotation in degrees from text annotation

SecurityLevelEnum
annotationManager.textAnnotations.securityLevelEnum string

Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable

Selectable
annotationManager.textAnnotations.selectable boolean

Defines if text annotation is selectable by user

Text
annotationManager.textAnnotations.text string

User defined Text of text annotation

Transparent
annotationManager.textAnnotations.transparent boolean

Text annotation should be transparent

Width
annotationManager.textAnnotations.width integer

Width of text in pixel per inch for 7200 DPI from text annotation

X
annotationManager.textAnnotations.x integer

X coordinate in pixel per inch for 7200 DPI from text annotation

Y
annotationManager.textAnnotations.y integer

Y coordinate in pixel per inch for 7200 DPI from text annotation

blogs
blogs array of object

blogs

CreatedDate
blogs.createdDate string

Date on which the Blog was created. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
blogs.creatorId string

User Id of the creating user blog

Id
blogs.id string

Id of the blog

Text
blogs.text string

Text of blog item

CheckOutStateEnum
checkOutStateEnum string

Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null)

CheckOutUserId
checkOutUserId string

Id of the user for which document is checked out

documentData
documentData array of object

documentData

Id
documentData.id string

Id of document data

Name
documentData.name string

Document data name

renditions
documentData.renditions array of object

renditions

contentProtections
documentData.renditions.contentProtections array of

contentProtections

extension
documentData.renditions.extension string

Extension of rendition

files
documentData.renditions.files array of object

files

blobPath
documentData.renditions.files.blobPath string

Blob path of rendition

blobStoreId
documentData.renditions.files.blobStoreId string

Blob store Id of rendition

id
documentData.renditions.id string

id

pageCount
documentData.renditions.pageCount string

Page count of rendition

size
documentData.renditions.size string

Size of rendition

HasOverlay
hasOverlay boolean

Defines if the document should be displayed with a overlay

Id
id string

Id of the document

ImportTemplateId
importTemplateId string

Id of the import template for this document

InfoStoreId
infoStoreId string

Id of the info store

CheckOutLifeCycleStateId
lifeCycleManager.checkOutLifeCycleStateId string

Checkout life cycle state

LifeCycleEndDate
lifeCycleManager.lifeCycleEndDate string

Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStartDate
lifeCycleManager.lifeCycleStartDate string

Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss

LifeCycleStateId
lifeCycleManager.lifeCycleStateId string

Id of the LifeCycle state

NextAutomaticLifeCycleStateId
lifeCycleManager.nextAutomaticLifeCycleStateId string

Next automatic life cycle state

nextLifeCycleStates
lifeCycleManager.nextLifeCycleStates array of string

nextLifeCycleStates

lifeCycleProtections
lifeCycleManager.lifeCycleProtections array of object

lifeCycleProtections

DeleteAfterExpiration
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration boolean

Allow to delete document after protection expiration

Id
lifeCycleManager.lifeCycleProtections.id string

Id of life cycle state protection

ProtectAnnotationChange
lifeCycleManager.lifeCycleProtections.protectAnnotationChange boolean

Protect against annotation changes

ProtectCheckOut
lifeCycleManager.lifeCycleProtections.protectCheckOut boolean

Protect against check out

ProtectContentChange
lifeCycleManager.lifeCycleProtections.protectContentChange boolean

Protect against content change

ProtectDelete
lifeCycleManager.lifeCycleProtections.protectDelete boolean

Protect against delete

ProtectPropertyChange
lifeCycleManager.lifeCycleProtections.protectPropertyChange boolean

Protect against property changes

ProtectProtectionDomainChange
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange boolean

Protect against security change

ProtectionDurationTicks
lifeCycleManager.lifeCycleProtections.protectionDurationTicks integer

Duration of protection

LifeCycleId
lifeCycleManager.lifeCycleId string

Id of the LifeCycle

MainFileLength
mainFileLength integer

Main file size

Name
name string

Name of the document

PageCount
pageCount integer

Page count of main file

properties
properties array of object

properties

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

culture
properties.globalValues.values.culture string

Culture

text
properties.globalValues.values.text string

Text

PropertyName
properties.propertyName string

Name of property

PropertyTypeId
properties.propertyTypeId string

Type id of the index field

values
properties.values array of string

values

ProtectionDomainId
protectionDomainId string

Id of the protection domain

reminders
reminders array of object

reminders

Description
reminders.description string

Description for reminder

Interval
reminders.interval integer

Interval in days between reminders

ProcessTemplateId
reminders.processTemplateId string

Process template Id for this reminder

ReminderDate
reminders.reminderDate string

Date of the reminder. Date format: yyyy-MM-ddTHH:mm:ss

ReminderId
reminders.reminderId string

Id of the reminder

subjectIds
reminders.subjectIds array of

subjectIds

UseUserFromProcessTemplate
reminders.useUserFromProcessTemplate boolean

Defines if the user definition from process template will be used

SigningProfileId
signingProfileId string

Id of the signing profile

VersionId
versionId string

Version id of the document

Update process

Update process

Parameters

Name Key Required Type Description
ArchiveUrl
ArchiveUrl True string

Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON)

ConnectionId
ConnectionId True string

The connection id to identify your connection

ProcessId
ProcessId True string

Id of process (Guid)

AssignUserLoginNames
AssignUserLoginNames string

Assign user login names to current task. (e.g.: peter.muster@kendox.com;megan.muster@kendox.com)

ProcessProperties
ProcessProperties string

Process properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713

Custom properties
CustomProperties string

Custom properties. Format: [||PropertyType] (e.g. [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Number])

Comment
Comment string

Comment

Culture
Culture string

The culture in which the property names are given (de, en, fr, ...). Default = de

Returns

Name Path Type Description
accessRightsEnumList
accessRightsEnumList array of string

accessRightsEnumList

CheckOutState
checkOutStateEnum string

Check out state of the process (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null):

CheckOutUserId
checkOutUserId string

Id of the user for which document is checked out

comments
comments array of object

comments

Date
comments.date string

Date of comment

Id
comments.id string

Id of comment

Text
comments.text string

User defined comment

UserId
comments.userId string

User id

CompletedDate
completedDate string

Completed date of the process Date format: yyyy-MM-ddTHH:mm:ss

completedTasks
completedTasks array of object

completedTasks

Action
completedTasks.action string

Action text for the user. Displayed to the end user

assignedUserIds
completedTasks.assignedUserIds array of

assignedUserIds

comments
completedTasks.comments array of object

comments

Date
completedTasks.comments.date string

Date of comment

Id
completedTasks.comments.id string

Id of comment

Text
completedTasks.comments.text string

User defined comment

UserId
completedTasks.comments.userId string

Id of user, who has set the comment

CompletedDate
completedTasks.completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

completedUserIds
completedTasks.completedUserIds array of string

completedUserIds

CreatedDate
completedTasks.createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
completedTasks.creatorId string

User id of the creator

Description
completedTasks.description string

Task description

DueDate
completedTasks.dueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

intendedUserIds
completedTasks.intendedUserIds array of

intendedUserIds

ReminderDate
completedTasks.reminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
completedTasks.requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
completedTasks.showCloseTaskDialog boolean

Show close task dialog at task end

Status
completedTasks.statusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
completedTasks.taskTemplateId string

Task template id

CreatedDate
createdDate string

Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss

Action
currentTask.action string

Action text for the user. Displayed to the end user

assignedUserIds
currentTask.assignedUserIds array of string

assignedUserIds

comments
currentTask.comments array of object

comments

Date
currentTask.comments.date string

Date of comment

Id
currentTask.comments.id string

Id of comment

Text
currentTask.comments.text string

User defined comment

UserId
currentTask.comments.userId string

Id of user, who has set the comment

CompletedDate
currentTask.completedDate string

Completion date. Date format: yyyy-MM-ddTHH:mm:ss

completedUserIds
currentTask.completedUserIds array of string

completedUserIds

CreatedDate
currentTask.createdDate string

Creation date. Date format: yyyy-MM-ddTHH:mm:ss

CreatorId
currentTask.creatorId string

User id of the creator

Description
currentTask.description string

Task description

DueDate
currentTask.dueDate string

Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss

intendedUserIds
currentTask.intendedUserIds array of string

intendedUserIds

ReminderDate
currentTask.reminderDate string

Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss

RequiresAllRecipients
currentTask.requiresAllRecipients boolean

Defines if all recipients have to close this task

ShowCloseTaskDialog
currentTask.showCloseTaskDialog boolean

Show close task dialog at task end

Status
currentTask.statusEnum string

Status of task (Open, InProcess, Complete, PreparedToComplete, Error)

TaskTemplateId
currentTask.taskTemplateId string

Task template id

customProperties
customProperties array of object

customProperties

CustomProperties
customProperties object

List of all custom properties

documentIds
documentIds array of string

documentIds

DueDate
dueDate string

Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss

FolderElementId
folderElementId string

Id of document as folder element

HasLinks
hasLinks boolean

Id of document as folder element

Id
id string

Process id

values
name.values array of object

values

Culture
name.values.culture string

The culture in which the text is given (de, en, fr, ...)

Text
name.values.text string

The text for this language

Priority
priorityEnum string

Priority of process (High, Normal, Low)

PluginStream
pluginStream string

Data container for plugins

ProcessTemplateId
processTemplateId string

Process template id

properties
properties array of object

properties

globalValues
properties.globalValues array of object

globalValues

values
properties.globalValues.values array of object

values

culture
properties.globalValues.values.culture string

culture

text
properties.globalValues.values.text string

text

PropertyTypeId
properties.propertyTypeId string

Type id of the index field

values
properties.values array of string

values

ProtectionDomainId
protectionDomainId string

Protection domain id of process

SessionCount
sessionCount integer

Session count

Status
statusEnum string

Status of process (Open, InProcess, Complete, PreparedToComplete, Error)