Connectors Reference
InfoShare is designed for use in businesses seeking to optimise the way they manage digital documents, information, binders and processes.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Logon |
|
|
CloseTaskAndAssignToUsers (CloseTaskAndAssignToUsersParameterBody body) |
Close current task and assign user to next task |
|
Create document |
|
|
Update document |
|
|
List processes |
|
|
Logoff |
|
|
Update process |
|
|
Document Search |
|
|
GetDocumentProperties (GetDocumentPropertiesParameterBody body) |
Get document properties |
|
GetProcessProperties (GetProcessPropertiesParameterBody body) |
Get process properties |
|
Get file content |
|
|
CloseProcess (string ArchiveUrl, CloseProcessParameterBody body) |
Close an open process |
|
LogonWithHashedPassword (string ArchiveUrl, LogonWithHashedPasswordParameterBody body) |
Logon with hashed password |
|
Close task and continue process |
|
|
GetDocument (string ArchiveUrl, GetDocumentParameterBody body) |
Get document |
|
GetProcess (string ArchiveUrl, GetProcessParameterBody body) |
Get process |
|
GetFileContentConverted (GetFileContentConvertedParameterBody body) |
Get file content converted |
|
Create process |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Logon
Description: Logon
Syntax:
InfoShare.Logon (LogonParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:LogonResponse
Summary: Close current task and assign user to next task
Description: Close current task and assign user to next task
Syntax:
InfoShare.CloseTaskAndAssignToUsers (CloseTaskAndAssignToUsersParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CloseTaskAndAssignToUsersParameterBody
|
|
True |
Returns:
Type:CloseTaskAndAssignToUsersResponse
Summary: Create document
Description: Create document
Syntax:
InfoShare.CreateDocument (CreateDocumentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Update document
Description: Update document
Syntax:
InfoShare.UpdateDocument (UpdateDocumentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: List processes
Description: List processes
Syntax:
InfoShare.ListProcesses (ListProcessesParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Logoff
Description: Logoff
Syntax:
InfoShare.Logoff (LogoffParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:LogoffResponse
Summary: Update process
Description: Update process
Syntax:
InfoShare.UpdateProcess (UpdateProcessParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Document Search
Description: Document Search
Syntax:
InfoShare.DocumentSearch (DocumentSearchParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Get document properties
Description: Get document properties
Syntax:
InfoShare.GetDocumentProperties (GetDocumentPropertiesParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
GetDocumentPropertiesParameterBody
|
|
True |
Returns:
Type:array of (GetDocumentPropertiesResponseItem)
Summary: Get process properties
Description: Get process properties
Syntax:
InfoShare.GetProcessProperties (GetProcessPropertiesParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
GetProcessPropertiesParameterBody
|
|
True |
Returns:
Type:array of (GetProcessPropertiesResponseItem)
Summary: Get file content
Description: Get file content
Syntax:
InfoShare.GetFileContent (GetFileContentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:GetFileContentResponseFile Content
Title: File Content
Description: File Content
Summary: Close an open process
Description: Close an open process
Syntax:
InfoShare.CloseProcess (string ArchiveUrl, CloseProcessParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ArchiveUrl |
string (Url of Archive API (e.g.: https://documentarchive.ch/sdk/wcfJSON)) |
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
True |
|
|
body |
|
|
True |
Returns:
Type:CloseProcessResponse
Summary: Logon with hashed password
Description: Logon with hashed password
Syntax:
InfoShare.LogonWithHashedPassword (string ArchiveUrl, LogonWithHashedPasswordParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ArchiveUrl |
string (Url of Archive API (e.g.: https://documentarchive.ch/sdk/wcfJSON)) |
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
True |
|
|
body |
LogonWithHashedPasswordParameterBody
|
|
True |
Returns:
Type:LogonWithHashedPasswordResponse
Summary: Close task and continue process
Description: Close task and continue process
Syntax:
InfoShare.CloseTask (string ArchiveUrl, CloseTaskParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ArchiveUrl |
string (Url of Archive API (e.g.: https://documentarchive.ch/sdk/wcfJSON)) |
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
True |
|
|
body |
|
|
True |
Returns:
Type:CloseTaskResponse
Summary: Get document
Description: Get document
Syntax:
InfoShare.GetDocument (string ArchiveUrl, GetDocumentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ArchiveUrl |
string (Url of Archive API (e.g.: https://documentarchive.ch/sdk/wcfJSON)) |
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
True |
|
|
body |
|
|
True |
Returns:
Type:GetDocumentResponse
Summary: Get process
Description: Get Process
Syntax:
InfoShare.GetProcess (string ArchiveUrl, GetProcessParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
ArchiveUrl |
string (Url of Archive API (e.g.: https://documentarchive.ch/sdk/wcfJSON)) |
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
True |
|
|
body |
|
|
True |
Returns:
Type:GetProcessResponse
Summary: Get file content converted
Description: Convert file content to different format. Add annotation or overlay to file content
Syntax:
InfoShare.GetFileContentConverted (GetFileContentConvertedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
GetFileContentConvertedParameterBody
|
|
True |
Returns:
Type:GetFileContentConvertedResponseFile Content
Title: File Content
Description: File content converted
Summary: Create process
Description: Create process
Syntax:
InfoShare.CreateProcess (CreateProcessParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionId |
string
|
The connection id to identify your connection |
|
processId |
string
|
Id of process (Guid) |
|
comment |
string
|
Comment to add |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CloseProcessResult |
|
CloseProcessResult |
Summary:
Description: CloseProcessResult
Properties:
|
Name |
Type |
Summary |
|
AccessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
CheckOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId |
string
|
Id of the user for which process is checked out |
|
Comments |
array of (CommentsItem)
|
Comments |
|
CompletedDate |
string
|
Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedTasks |
array of (CompletedTasksItem)
|
CompletedTasks |
|
CreatedDate |
string
|
Creation date of the process Date format: yyyy-MM-ddTHH:mm:ss |
|
CurrentTask |
|
CurrentTask |
|
CustomProperties |
array of (CustomPropertiesItem)
|
CustomProperties |
|
DocumentIds |
array of (string)
|
DocumentIds |
|
DueDate |
string
|
Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
Id |
string
|
Id of process |
|
Name |
|
Name |
|
PluginStream |
array of (string)
|
PluginStream |
|
PriorityEnum |
string
|
Priority of process (High, Normal, Low) |
|
ProcessTemplateId |
string
|
Process template id |
|
Properties |
array of (PropertiesItem)
|
Properties |
|
ProtectionDomainId |
string
|
Protection domain id of process |
|
SessionCount |
integer(int32)
|
Session count |
|
StatusEnum |
string
|
Status of process (Open, InProcess, Complete, PreparedToComplete, Error) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Date |
string
|
Date of comment |
|
Id |
string
|
Id of comment |
|
Text |
string
|
User defined comment |
|
UserId |
string
|
User id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Action |
string
|
Action text for the user |
|
AssignedUserIds |
array of (AssignedUserIdsItem)
|
AssignedUserIds |
|
Comments |
array of (CommentsItem)
|
Comments |
|
CompletedDate |
string
|
Completion date of completed task. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds |
array of (string)
|
CompletedUserIds |
|
CreatedDate |
string
|
Creation date of completed task. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User id of the creator of completed task |
|
Description |
string
|
Task description of completed task |
|
DueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
Id |
string
|
Id of the task |
|
IntendedUserIds |
array of (IntendedUserIdsItem)
|
IntendedUserIds |
|
ReminderDate |
string
|
Date for reminder of completed task. Date format: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
ShowCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
StatusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Date |
string
|
Date of comment |
|
Id |
string
|
Id of comment |
|
Text |
string
|
User defined comment |
|
UserId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: CurrentTask
Properties:
|
Name |
Type |
Summary |
|
Action |
string
|
Action text for the user |
|
AssignedUserIds |
array of (string)
|
AssignedUserIds |
|
Comments |
array of (CommentsItem)
|
Comments |
|
CompletedDate |
string
|
Completion date of current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds |
array of (string)
|
CompletedUserIds |
|
CreatedDate |
string
|
Creation date of current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User id of the creator of current task |
|
Description |
string
|
Task description of current task |
|
DueDate |
string
|
Due date of the current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
Id |
string
|
Id of the current task |
|
IntendedUserIds |
array of (string)
|
IntendedUserIds |
|
ReminderDate |
string
|
Date for reminder of current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients |
boolean
|
Defines if all recipients have to close the current task Values: [, ] |
|
ShowCloseTaskDialog |
boolean
|
Show close task dialog at current task Values: [, ] |
|
StatusEnum |
string
|
Status of current task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId |
string
|
Task template id of current task |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Date |
string
|
Date of comment |
|
Id |
string
|
Id of comment |
|
Text |
string
|
User defined comment |
|
UserId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CustomPropertyTypeEnum |
string
|
Custom property type enum value of custom property (String, Date, Number) |
|
Name |
string
|
Name of the custom property |
|
Value |
string
|
Value of the custom property |
Summary:
Description: Name
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Culture |
string
|
The culture in which the text is given (de, en, fr, ...) |
|
Text |
string
|
Name of process |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GlobalValues |
array of (GlobalValuesItem)
|
GlobalValues |
|
PropertyTypeId |
string
|
Type id of the index field |
|
Values |
array of (string)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Culture |
string
|
Culture |
|
Text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
ProcessId |
string
|
Id of process (Guid) |
|
TaskId |
string
|
Id of task (Guid) |
|
Comment |
string
|
Comment |
|
AssignUserLoginNames |
string
|
AssignUserLoginNames |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
array of (string)
|
assignedUserIds |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds |
array of (string)
|
CompletedUserIds |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of the creator |
|
description |
string
|
Task description |
|
dueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
array of (string)
|
intendedUserIds |
|
reminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status of task Status (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionId |
string
|
The connection id to identify your connection |
|
processId |
string
|
Id of process (Guid) |
|
comment |
string
|
Comment to add |
|
taskId |
string
|
Task id |
|
assignUsers |
boolean
|
Assign to users. If set to no, assign user with action Update process Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
string
|
List of assigned user ids |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds |
string
|
List of all completed user ids |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of the creator |
|
description |
string
|
Task description |
|
dueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
string
|
Intended users for this task |
|
reminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status of task Status (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
User Id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
DocumentTitle |
string
|
Title of document (incl. extension) |
|
ImportTemplate |
string
|
Import template |
|
DocumentProperties |
string
|
Document properties insert format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
Culture |
string
|
The culture in which the property names are given (de, en, fr, ...). Default is de |
|
FileContent |
string
|
File content base64 string |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
abonnements |
array of (string)
|
abonnements |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
annotationManager |
|
annotationManager |
|
blogs |
array of (BlogsItem)
|
blogs |
|
checkOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId |
string
|
Id of the user for which document is checked out |
|
documentData |
array of (DocumentDataItem)
|
documentData |
|
hasOverlay |
boolean
|
Defines if the document should be displayed with a overlay Values: [, ] |
|
id |
string
|
Id of the document |
|
importTemplateId |
string
|
Id of the import template for this document |
|
infoStoreId |
string
|
Id of the info store |
|
lifeCycleManager |
|
lifeCycleManager |
|
mainFileLength |
integer(int32)
|
Main file size |
|
name |
string
|
Name of the document |
|
pageCount |
integer(int32)
|
Page count of main file |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Id of the protection domain |
|
reminders |
array of (RemindersItem)
|
reminders |
|
sessionCount |
integer(int32)
|
Session count |
|
signingProfileId |
string
|
Id of the signing profile |
|
versionId |
string
|
Version id of the document |
Summary:
Description: annotationManager
Properties:
|
Name |
Type |
Summary |
|
postItAnnotations |
array of (PostItAnnotationsItem)
|
postItAnnotations |
|
rectangleAnnotations |
array of (RectangleAnnotationsItem)
|
rectangleAnnotations |
|
textAnnotations |
array of (TextAnnotationsItem)
|
textAnnotations |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createdDate |
string
|
Creation date from post it annotation |
|
creatorId |
string
|
User id of creator from post it annotation |
|
fontInfo |
|
fontInfo |
|
id |
string
|
Id of the post it annotation |
|
modifiedDate |
string
|
Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from post it annotation |
|
securityLevelEnum |
string
|
Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if post it annotation is selectable by user Values: [, ] |
|
text |
string
|
User defined text for post it annotation |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI of post it annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI of post it annotation |
Summary:
Description: fontInfo
Properties:
|
Name |
Type |
Summary |
|
isItalic |
boolean
|
Is font italic from post it annotation Values: [, ] |
|
isStrikeOut |
boolean
|
Is Font strike out from post it annotation Values: [, ] |
|
isUnderline |
boolean
|
Is Font is underline from post it annotation Values: [, ] |
|
name |
string
|
Font name from post it annotation. Default: "Arial" |
|
pitch |
integer(int32)
|
Font pitch from post it annotation |
|
size |
integer(int32)
|
Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000 |
|
weight |
integer(int32)
|
Font weight from post it annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
color |
integer(int32)
|
Color of rectangle (32 bit ARGB value) from rectangle annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
colorHexCode |
string
|
Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
createdDate |
string
|
Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
CreatorId |
|
height |
integer(int32)
|
Height of rectangle in pixel per inch for 7200 DPI |
|
Id |
string
|
Id of the rectangle annotation |
|
modifiedDate |
string
|
Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from rectangle annotation |
|
securityLevelEnum |
string
|
Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if rectangle annotation is selectable by user Values: [, ] |
|
transparent |
boolean
|
Rectangle should be transparent (highlight) Values: [, ] |
|
width |
integer(int32)
|
Width of rectangle in pixel per inch for 7200 DPI |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from rectangle annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from rectangle annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
backgroundColor |
integer(int32)
|
Color of background (32 bit ARGB value) from text annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
backgroundColorHexCode |
string
|
Color of background (RGB hexadecimal code) from text annotation Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
createdDate |
string
|
creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of creator from text annotation |
|
fontInfo |
|
fontInfo |
|
foregroundColor |
integer(int32)
|
Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
foregroundColorHexCode |
string
|
Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
height |
integer(int32)
|
Height of text in pixel per inch for 7200 DPI from text annotation |
|
id |
string
|
Id of text annotation |
|
modifiedDate |
string
|
Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from text annotation |
|
rotation |
integer(int32)
|
Rotation in degrees from text annotation |
|
securityLevelEnum |
string
|
Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if text annotation is selectable by user Values: [, ] |
|
text |
string
|
User defined Text of text annotation |
|
transparent |
boolean
|
Text annotation should be transparent Values: [, ] |
|
width |
integer(int32)
|
Width of text in pixel per inch for 7200 DPI from text annotation |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from text annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from text annotation |
Summary:
Description: fontInfo
Properties:
|
Name |
Type |
Summary |
|
isItalic |
boolean
|
Is Font italic from text annotation Values: [, ] |
|
isStrikeOut |
boolean
|
Is font strike out from text annotation Values: [, ] |
|
isUnderline |
boolean
|
Is font underline from text annotation Values: [, ] |
|
name |
string
|
Font name from text annotation. Default: "Arial" |
|
pitch |
integer(int32)
|
Font pitch from text annotation |
|
size |
integer(int32)
|
Font size from text annotation. Example: Size:12 is 12000. You need factor 1000 |
|
weight |
integer(int32)
|
Font weight from text annotation |
Summary:
Description: List of all blog items
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of document rendition |
|
name |
string
|
Document name of rendition |
|
renditions |
array of (RenditionsItem)
|
renditions |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contentProtections |
array of (ContentProtectionsItem)
|
contentProtections |
|
extension |
string
|
Extension of rendition |
|
files |
array of (FilesItem)
|
files |
|
id |
string
|
id |
|
pageCount |
string
|
Page count of rendition |
|
size |
string
|
Size of rendition |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
blobPath |
string
|
Blob path of rendition |
|
blobStoreId |
string
|
Blob store Id of rendition |
Summary:
Description: lifeCycleManager
Properties:
|
Name |
Type |
Summary |
|
checkOutLifeCycleStateId |
string
|
Checkout life cycle state |
|
lifeCycleEndDate |
string
|
Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
lifeCycleStartDate |
string
|
Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
lifeCycleStateId |
string
|
Id of the LifeCycle state |
|
nextAutomaticLifeCycleStateId |
string
|
Next automatic life cycle state |
|
nextLifeCycleStates |
array of (string)
|
nextLifeCycleStates |
|
lifeCycleProtections |
array of (LifeCycleProtectionsItem)
|
lifeCycleProtections |
|
lifeCycleId |
string
|
Id of the LifeCycle |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
deleteAfterExpiration |
boolean
|
Allow to delete document after protection expiration Values: [, ] |
|
id |
string
|
Id of life cycle state protection |
|
protectAnnotationChange |
boolean
|
Protect against annotation changes Values: [, ] |
|
protectCheckOut |
boolean
|
Protect against check out Values: [, ] |
|
protectContentChange |
boolean
|
Protect against content change Values: [, ] |
|
protectDelete |
boolean
|
Protect against delete Values: [, ] |
|
protectPropertyChange |
boolean
|
Protect against property changes Values: [, ] |
|
protectProtectionDomainChange |
boolean
|
Protect against security change Values: [, ] |
|
protectionDurationTicks |
integer(int32)
|
Duration of protection |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
globalValues |
array of (GlobalValuesItem)
|
globalValues |
|
propertyTypeId |
string
|
Type id of the index field |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
Culture |
|
text |
string
|
Text |
Summary:
Description: List of all reminders
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
ProcessProperties |
string
|
Process properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
CustomProperties |
string
|
Custom properties. Format: [<PropertyName>|<PropertyValue>|PropertyType] (e.g. [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Number]) |
|
DocumentIds |
string
|
List of all document Ids to attach |
|
ProcessTemplateName |
string
|
Name of process template |
|
DueDate |
string
|
Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss. Default is current date |
|
Priority |
string
|
Priority of process (e.g. Low, Normal, High). Default is Normal Values: [Low, Normal, High] |
|
Comment |
string
|
Process comment |
|
Culture |
string
|
The culture in which the text is given (de, en, fr, ...). Default is de |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
checkOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId |
string
|
Id of the user for which process is checked out |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedTasks |
array of (string)
|
completedTasks |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
currentTask |
|
currentTask |
|
customProperties |
array of (CustomPropertiesItem)
|
customProperties |
|
documentIds |
array of (string)
|
documentIds |
|
dueDate |
string
|
Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
folderElementId |
string
|
Id of document as folder element |
|
hasLinks |
boolean
|
Id of document as folder element Values: [, ] |
|
id |
string
|
Process id |
|
name |
|
name |
|
priorityEnum |
string
|
Priority of process (High, Normal, Low). Default is Normal |
|
pluginStream |
string
|
Data container for plugins |
|
processTemplateId |
string
|
Process template id |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Protection domain id of process |
|
statusEnum |
string
|
Status of process (Open, InProcess, Complete, PreparedToComplete, Error) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
User Id |
Summary:
Description: currentTask
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
array of (string)
|
assignedUserIds |
|
comments |
array of (string)
|
comments |
|
completedDate |
string
|
Completion date for current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds |
array of (string)
|
completedUserIds |
|
createdDate |
string
|
Creation date for current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of creator for current task |
|
description |
string
|
Description of current task |
|
dueDate |
string
|
Due date of current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
array of (string)
|
intendedUserIds |
|
reminderDate |
string
|
Date for reminder of current task. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status current task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Template id of current task |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
customPropertyTypeEnum |
string
|
Custom property type enum value (String, Date, Number) |
|
name |
string
|
Name of custom property |
|
value |
string
|
Value of custom property |
Summary:
Description: name
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
The culture in which the text is given (de, en, fr, ...) |
|
text |
string
|
The text for this language |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
globalValues |
array of (GlobalValuesItem)
|
globalValues |
|
propertyName |
string
|
Name of process property |
|
propertyTypeId |
string
|
Id of process property |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
culture |
|
text |
string
|
text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
Conditions |
string
|
Search condition format: [<PropertyName>|<PropertyValue>|<ComparisonEnum>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". e.g.: [Last check in|2021-12-31|Less|And][Firstname|Peter|Equals|And] |
|
Culture |
string
|
Culture (de,en,fr,...). Default is de |
|
FulltextWords |
string
|
Words to be searcheds with fulltext |
|
FulltextWordRelation |
string
|
Fulltext word relation (AND, OR). Default is AND Values: [AND, OR] |
|
MaxSerchResults |
string
|
Maximum number of document search results. Default is 100 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (DocumentsItem)
|
documents |
|
hasMore |
boolean
|
Indicates, whether more results exists or not. The flag is set to true if more results are available Values: [, ] |
|
resumePoint |
string
|
The resume point from previous search operation. Set null for the first search operation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
abonnements |
string
|
List of abonnements |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
annotationManager |
string
|
Annotations for main document file |
|
blogs |
string
|
List of all blog items |
|
checkOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId |
string
|
Id of the user for which document is checked out |
|
documentData |
string
|
Document data list |
|
hasOverlay |
boolean
|
Defines if the document should be displayed with a overlay Values: [, ] |
|
id |
string
|
Id of the document |
|
importTemplateId |
string
|
Id of the import template for this document |
|
infoStoreId |
string
|
Id of the info store |
|
lifeCycleManager |
string
|
Life cycle informations |
|
mainFileLength |
integer(int32)
|
Main file size |
|
name |
string
|
Name of the document |
|
pageCount |
integer(int32)
|
Page count of main file |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Id of the protection domain |
|
reminders |
string
|
List of all reminders |
|
sessionCount |
integer(int32)
|
Session count |
|
signingProfileId |
string
|
Id of the signing profile |
|
versionId |
string
|
Version id of the document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionId |
string
|
The connection id to identify your connection |
|
documentId |
string
|
The document id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
DocumentId |
string
|
Id of document |
|
Culture |
string
|
The culture in which the property names are given (de, en, fr, ...). Default is de |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
globalValues |
array of (GlobalValuesItem)
|
globalValues |
|
propertyName |
string
|
Name of property |
|
propertyTypeId |
string
|
Type id of the index field |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
Culture |
|
text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetDocumentResult |
|
GetDocumentResult |
Summary:
Description: GetDocumentResult
Properties:
|
Name |
Type |
Summary |
|
Abonnements |
array of (AbonnementsItem)
|
Abonnements |
|
AccessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
AnnotationManager |
|
AnnotationManager |
|
Blogs |
array of (BlogsItem)
|
Blogs |
|
CheckOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId |
string
|
Id of the user for which document is checked out |
|
DocumentData |
array of (DocumentDataItem)
|
DocumentData |
|
HasOverlay |
boolean
|
Defines if the document should be displayed with a overlay Values: [, ] |
|
Id |
string
|
Id of the document |
|
ImportTemplateId |
string
|
Id of the import template for this document |
|
InfoStoreId |
string
|
Id of the info store |
|
LifeCycleManager |
|
LifeCycleManager |
|
MainFileLength |
integer(int32)
|
Main file size |
|
Name |
string
|
Name of the document |
|
PageCount |
integer(int32)
|
Page count of main file |
|
Properties |
array of (PropertiesItem)
|
Properties |
|
ProtectionDomainId |
string
|
Id of the protection domain |
|
Reminders |
array of (RemindersItem)
|
Reminders |
|
SessionCount |
integer(int32)
|
Session count |
|
SigningProfileId |
string
|
Id of the signing profile |
|
VersionId |
string
|
Version id of the document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
OnContentChange |
boolean
|
Abonnement is active on file changes Values: [, ] |
|
OnDelete |
boolean
|
Abonnement is active on delete Values: [, ] |
|
OnMetadataChange |
boolean
|
Abonnement is active on index changes Values: [, ] |
|
UserId |
string
|
The user id for this abonnnement |
Summary:
Description: AnnotationManager
Properties:
|
Name |
Type |
Summary |
|
PostItAnnotations |
array of (PostItAnnotationsItem)
|
PostItAnnotations |
|
RectangleAnnotations |
array of (RectangleAnnotationsItem)
|
RectangleAnnotations |
|
TextAnnotations |
array of (TextAnnotationsItem)
|
TextAnnotations |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CreatedDate |
string
|
Creation date from post it annotation |
|
CreatorId |
string
|
User id of creator from post it annotation |
|
FontInfo |
|
FontInfo |
|
Id |
string
|
Id of the post it annotation |
|
ModifiedDate |
string
|
Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
PageNumber |
integer(int32)
|
Number of page from post it annotation |
|
SecurityLevelEnum |
string
|
Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
Selectable |
boolean
|
Defines if post it annotation is selectable by user Values: [, ] |
|
Text |
string
|
User defined text for post it annotation |
|
X |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI of post it annotation |
|
Y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI of post it annotation |
Summary:
Description: FontInfo
Properties:
|
Name |
Type |
Summary |
|
IsItalic |
boolean
|
Is font italic from post it annotation Values: [, ] |
|
IsStrikeOut |
boolean
|
Is Font strike out from post it annotation Values: [, ] |
|
IsUnderline |
boolean
|
Is Font is underline from post it annotation Values: [, ] |
|
Name |
string
|
Font name from post it annotation. Default: "Arial" |
|
Pitch |
integer(int32)
|
Font pitch from post it annotation |
|
Size |
integer(int32)
|
Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000 |
|
Weight |
integer(int32)
|
Font weight from post it annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Color |
integer(int32)
|
Color of rectangle (32 bit ARGB value) from rectangle annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ColorHexCode |
string
|
Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate |
string
|
Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
CreatorId |
|
Height |
integer(int32)
|
Height of rectangle in pixel per inch for 7200 DPI |
|
Id |
string
|
Id of the rectangle annotation |
|
ModifiedDate |
string
|
Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
PageNumber |
integer(int32)
|
Number of page from rectangle annotation |
|
SecurityLevelEnum |
string
|
Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
Selectable |
boolean
|
Defines if rectangle annotation is selectable by user Values: [, ] |
|
Transparent |
boolean
|
Rectangle should be transparent (highlight) Values: [, ] |
|
Width |
integer(int32)
|
Width of rectangle in pixel per inch for 7200 DPI |
|
X |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from rectangle annotation |
|
Y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from rectangle annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
BackgroundColor |
integer(int32)
|
Color of background (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
BackgroundColorHexCode |
string
|
Color of background (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
CreatedDate |
string
|
creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User id of creator from text annotation |
|
FontInfo |
|
FontInfo |
|
ForegroundColor |
integer(int32)
|
Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
ForegroundColorHexCode |
string
|
Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
Height |
integer(int32)
|
Height of text in pixel per inch for 7200 DPI from text annotation |
|
Id |
string
|
Id of text annotation |
|
ModifiedDate |
string
|
Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
PageNumber |
integer(int32)
|
Number of page from text annotation |
|
Rotation |
integer(int32)
|
Rotation in degrees from text annotation |
|
SecurityLevelEnum |
string
|
Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
Selectable |
boolean
|
Defines if text annotation is selectable by user Values: [, ] |
|
Text |
string
|
User defined Text of text annotation |
|
Transparent |
boolean
|
Text annotation should be transparent Values: [, ] |
|
Width |
integer(int32)
|
Width of text in pixel per inch for 7200 DPI from text annotation |
|
X |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from text annotation |
|
Y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from text annotation |
Summary:
Description: FontInfo
Properties:
|
Name |
Type |
Summary |
|
IsItalic |
boolean
|
Is Font italic from text annotation Values: [, ] |
|
IsStrikeOut |
boolean
|
Is font strike out from text annotation Values: [, ] |
|
IsUnderline |
boolean
|
Is font underline from text annotation Values: [, ] |
|
Name |
string
|
Font name from text annotation. Default: "Arial" |
|
Pitch |
integer(int32)
|
Font pitch from text annotation |
|
Size |
integer(int32)
|
Font size from text annotation.. Example: Size:12 is 12000. You need factor 1000 |
|
Weight |
integer(int32)
|
Font weight from text annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CreatedDate |
string
|
Date on which the Blog was created. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User Id of the creating user blog |
|
Id |
string
|
Id of the blog |
|
Text |
string
|
Text of blog item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id of document rendition |
|
Name |
string
|
Document name of rendition |
|
Renditions |
array of (RenditionsItem)
|
Renditions |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ContentProtections |
array of (ContentProtectionsItem)
|
ContentProtections |
|
Extension |
string
|
Extension |
|
Files |
array of (FilesItem)
|
Files |
|
HashValue |
array of (integer(int32))
|
HashValue |
|
Id |
string
|
Id |
|
PageCount |
integer(int32)
|
PageCount |
|
Size |
integer(int32)
|
Size |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
BlobPath |
string
|
BlobPath |
|
BlobStoreId |
string
|
BlobStoreId |
Summary:
Description: LifeCycleManager
Properties:
|
Name |
Type |
Summary |
|
CheckOutLifeCycleStateId |
string
|
Checkout life cycle state |
|
LifeCycleEndDate |
string
|
Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate |
string
|
Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId |
string
|
Id of the LifeCycle state |
|
NextAutomaticLifeCycleStateId |
string
|
Next automatic life cycle state |
|
NextLifeCycleStates |
array of (string)
|
NextLifeCycleStates |
|
LifeCycleProtections |
array of (LifeCycleProtectionsItem)
|
LifeCycleProtections |
|
LifeCycleId |
string
|
Id of the LifeCycle |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
DeleteAfterExpiration |
boolean
|
Allow to delete document after protection expiration Values: [, ] |
|
Id |
string
|
Id of life cycle state protection |
|
ProtectAnnotationChange |
boolean
|
Protect against annotation changes Values: [, ] |
|
ProtectCheckOut |
boolean
|
Protect against check out Values: [, ] |
|
ProtectContentChange |
boolean
|
Protect against content change Values: [, ] |
|
ProtectDelete |
boolean
|
Protect against delete Values: [, ] |
|
ProtectPropertyChange |
boolean
|
Protect against property changes Values: [, ] |
|
ProtectProtectionDomainChange |
boolean
|
Protect against security change Values: [, ] |
|
ProtectionDurationTicks |
integer(int32)
|
Duration of protection |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GlobalValues |
array of (GlobalValuesItem)
|
GlobalValues |
|
PropertyTypeId |
string
|
Type id of the index field |
|
Values |
array of (string)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Culture |
string
|
Culture |
|
Text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Description |
string
|
Description for reminder |
|
Interval |
integer(int32)
|
Interval in days between reminders |
|
ProcessTemplateId |
string
|
Process template Id for this reminder |
|
ReminderDate |
string
|
Date of the reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
ReminderId |
string
|
Id of the reminder |
|
SubjectIds |
array of (SubjectIdsItem)
|
subjectIds |
|
UseUserFromProcessTemplate |
boolean
|
Defines if the user definition from process template will be used Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
DocumentId |
string
|
Id of document |
|
VersionId |
string
|
Id of version (Guid)Id of version (Guid) |
|
DocumentDataId |
string
|
Id of document data (Guid) |
|
RenditionId |
string
|
Id of document rendition (Guid) |
|
TargetFormat |
string
|
The target format (e.g. "png;pdf;tif;...") |
|
AddAnnotatins |
boolean
|
Defines if document should be exported with annotations. Default is yes Values: [, ] |
|
AddOverlay |
boolean
|
Defines if document should be exported with overlays. Default is yes Values: [, ] |
Summary:
Description: File content converted
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
DocumentId |
string
|
Id of document |
|
VersionId |
string
|
Id of version (Guid) |
|
DocumentDataId |
string
|
Id of document data (Guid) |
|
RenditionId |
string
|
Id of document rendition (Guid) |
|
IgnoreHashValidation |
boolean
|
Ignore system configuration for hash validation. Default is yes Values: [, ] |
Summary:
Description: File Content
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionId |
string
|
The connection id to identify your connection |
|
processId |
string
|
Id of process (Guid) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
ProcessId |
string
|
Id of process (Guid) |
|
Culture |
string
|
The culture in which the property names are given (de, en, fr, ...). Default is de |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
propertyName |
string
|
Process property name |
|
propertyTypeId |
string
|
Property type id |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GetProcessResult |
|
GetProcessResult |
Summary:
Description: GetProcessResult
Properties:
|
Name |
Type |
Summary |
|
AccessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
CheckOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId |
string
|
Id of the user for which process is checked out |
|
Comments |
array of (CommentsItem)
|
Comments |
|
CompletedDate |
string
|
Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedTasks |
array of (CompletedTasksItem)
|
CompletedTasks |
|
CreatedDate |
string
|
Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
CurrentTask |
|
CurrentTask |
|
CustomProperties |
array of (CustomPropertiesItem)
|
CustomProperties |
|
DocumentIds |
array of (string)
|
DocumentIds |
|
DueDate |
string
|
Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
Id |
string
|
Id of process |
|
Name |
|
Name |
|
PluginStream |
array of (string)
|
PluginStream |
|
PriorityEnum |
string
|
Priority of process (High, Normal, Low) |
|
ProcessTemplateId |
string
|
Process template id |
|
Properties |
array of (PropertiesItem)
|
Properties |
|
ProtectionDomainId |
string
|
Protection domain id of process |
|
SessionCount |
integer(int32)
|
Session count |
|
StatusEnum |
string
|
Status of process (Open, InProcess, Complete, PreparedToComplete, Error) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Date |
string
|
Date of comment |
|
Id |
string
|
Id of comment |
|
Text |
string
|
User defined comment |
|
UserId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Action |
string
|
Action text for the user. Displayed to the end user |
|
AssignedUserIds |
array of (AssignedUserIdsItem)
|
assignedUserIds |
|
Comments |
array of (CommentsItem)
|
Comments |
|
CompletedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds |
array of (string)
|
completedUserIds |
|
CreatedDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User id of the creator |
|
Description |
string
|
Task description |
|
DueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
IntendedUserIds |
array of (IntendedUserIdsItem)
|
intendedUserIds |
|
ReminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
ShowCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
StatusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Date |
string
|
Date of comment |
|
Id |
string
|
Id of comment |
|
Text |
string
|
User defined comment |
|
UserId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: CurrentTask
Properties:
|
Name |
Type |
Summary |
|
Action |
string
|
Action text for the user. Displayed to the end user |
|
AssignedUserIds |
array of (string)
|
AssignedUserIds |
|
Comments |
array of (string)
|
Comments |
|
CompletedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
CompletedUserIds |
array of (string)
|
CompletedUserIds |
|
CreatedDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
CreatorId |
string
|
User id of the creator |
|
Description |
string
|
Task description |
|
DueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
Id |
string
|
Id of the task |
|
IntendedUserIds |
array of (string)
|
IntendedUserIds |
|
ReminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
ShowCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
StatusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CustomPropertyTypeEnum |
string
|
List of custom property data type (String, Date, Number) |
|
Name |
string
|
Name of custom property type |
|
Value |
string
|
Value of custom property type |
Summary:
Description: Name
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Culture |
string
|
The culture in which the text is given (de, en, fr, ...) |
|
Text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
GlobalValues |
array of (GlobalValuesItem)
|
GlobalValues |
|
PropertyTypeId |
string
|
Property type id |
|
Values |
array of (string)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Culture |
string
|
Culture |
|
Text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
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 |
string
|
Status of process. Default is open Values: [Open, InProcess, Complete, PreparedToComplete, Error] |
|
IgnoreReceiver |
boolean
|
If yes, all processes indipendent of receiver are listed. Default is false Values: [, ] |
|
MaxSerchResults |
string
|
Maximum number of process search results. Default is 100 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
processes |
array of (ProcessesItem)
|
processes |
|
hasMore |
boolean
|
Indicates, whether more results exists or not. The flag is set to true if more results are available Values: [, ] |
|
resumePoint |
string
|
The resume point from previous search operations. Set null for the first search operation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
checkOutStateEnum |
string
|
Check out state of the process (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId |
string
|
Id of the user for which document is checked out |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completed date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedTasks |
array of (CompletedTasksItem)
|
completedTasks |
|
createdDate |
string
|
Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
currentTask |
string
|
Currently active task |
|
customProperties |
string
|
List of all custom properties |
|
documentIds |
string
|
List of all attached document ids |
|
dueDate |
string
|
Due date for the process Date format: yyyy-MM-ddTHH:mm:ss |
|
folderElementId |
string
|
Id of process as folder element |
|
hasLinks |
boolean
|
Flag whether the process has links Values: [, ] |
|
id |
string
|
Id of process |
|
name |
|
name |
|
priorityEnum |
string
|
Priority of process (High, Normal, Low) |
|
pluginStream |
string
|
Data container for plugins |
|
processTemplateId |
string
|
Process template id |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Protection domain id of process |
|
statusEnum |
string
|
Status of process (Open, InProcess, Complete, PreparedToComplete, Error) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
array of (AssignedUserIdsItem)
|
assignedUserIds |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds |
array of (string)
|
completedUserIds |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of the creator |
|
description |
string
|
Task description |
|
dueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
array of (IntendedUserIdsItem)
|
intendedUserIds |
|
reminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: name
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
culture |
|
text |
string
|
text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
propertyName |
string
|
propertyName |
|
propertyTypeId |
string
|
propertyTypeId |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LogoffResult |
string
|
Result of logoff |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
Username |
string
|
User name for logon |
|
Password |
string
|
Password |
|
Tenantname |
string
|
Tenant name to logon to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionId |
string
|
Contains the connection id if successfully logged in |
|
connectionTimeoutSeconds |
integer(int32)
|
Timeout for connection |
|
isApplicationLicence |
string
|
Is application license type |
|
isConcurrentLicence |
string
|
Is concurrent licence type |
|
isNamedLicence |
string
|
Is named license typ |
|
isVerificationCodeNeeded |
string
|
Is verification code needed |
|
possibleTwoWayAuthenticationType |
string
|
Possible two way authentication type (None, Mail, SMS) |
|
twoWayAuthenticationTargetMail |
string
|
The masked mail address where twoWayAuthentication will send mail to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userName |
string
|
User name for logon |
|
passwordHashed |
string
|
User password for logon (Base64 encoded SHA 512 Hash) |
|
tenantName |
string
|
Tenant name to logon to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
LogonResult |
|
LogonResult |
Summary:
Description: LogonResult
Properties:
|
Name |
Type |
Summary |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
ConnectionTimeoutSeconds |
integer(int32)
|
Connection timeout in seconds |
|
IsApplicationLicence |
boolean
|
Is application license type Values: [, ] |
|
IsConcurrentLicence |
boolean
|
Is concurrent licence type Values: [, ] |
|
IsNamedLicence |
boolean
|
Is named license type Values: [, ] |
|
IsVerificationCodeNeeded |
boolean
|
Is verification code needed Values: [, ] |
|
JWTToken |
string
|
The JWT token for this connection |
|
PossibleTwoWayAuthenticationType |
string
|
Possible two way authentication type (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail |
string
|
The masked mail address where twoWayAuthentication will send mail to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
DocumentId |
string
|
Id of document |
|
DocumentTitle |
string
|
Title of document |
|
DocumentProperties |
string
|
Document properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
Culture |
string
|
The culture in which the text is given (de, en, fr, ...). Default is de |
|
FileContent |
string
|
File content base64 string |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
abonnements |
array of (AbonnementsItem)
|
abonnements |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
annotationManager |
|
annotationManager |
|
blogs |
array of (BlogsItem)
|
blogs |
|
checkOutStateEnum |
string
|
Check out state of the document (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId |
string
|
Id of the user for which document is checked out |
|
documentData |
array of (DocumentDataItem)
|
documentData |
|
hasOverlay |
boolean
|
Defines if the document should be displayed with a overlay Values: [, ] |
|
id |
string
|
Id of the document |
|
importTemplateId |
string
|
Id of the import template for this document |
|
infoStoreId |
string
|
Id of the info store |
|
lifeCycleManager |
|
lifeCycleManager |
|
mainFileLength |
integer(int32)
|
Main file size |
|
name |
string
|
Name of the document |
|
pageCount |
integer(int32)
|
Page count of main file |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Id of the protection domain |
|
reminders |
array of (RemindersItem)
|
reminders |
|
signingProfileId |
string
|
Id of the signing profile |
|
versionId |
string
|
Version id of the document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
onContentChange |
boolean
|
Abonnement is active on file changes Values: [, ] |
|
onDelete |
boolean
|
Abonnement is active on delete Values: [, ] |
|
onMetadataChange |
boolean
|
Abonnement is active on index changes Values: [, ] |
|
userId |
string
|
The user id for this abonnnement |
Summary:
Description: annotationManager
Properties:
|
Name |
Type |
Summary |
|
postItAnnotations |
array of (PostItAnnotationsItem)
|
postItAnnotations |
|
rectangleAnnotations |
array of (RectangleAnnotationsItem)
|
rectangleAnnotations |
|
textAnnotations |
array of (TextAnnotationsItem)
|
textAnnotations |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createdDate |
string
|
Creation date from post it annotation |
|
creatorId |
string
|
User id of creator from post it annotation |
|
fontInfo |
|
fontInfo |
|
id |
string
|
Id of the post it annotation |
|
modifiedDate |
string
|
Date of modification from post it annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from post it annotation |
|
securityLevelEnum |
string
|
Security level for post it annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if post it annotation is selectable by user Values: [, ] |
|
text |
string
|
User defined text for post it annotation |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI of post it annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI of post it annotation |
Summary:
Description: fontInfo
Properties:
|
Name |
Type |
Summary |
|
isItalic |
boolean
|
Is font italic from post it annotation Values: [, ] |
|
isStrikeOut |
boolean
|
Is Font strike out from post it annotation Values: [, ] |
|
isUnderline |
boolean
|
Is Font is underline from post it annotation Values: [, ] |
|
name |
string
|
Font name from post it annotation. Default: "Arial" |
|
pitch |
integer(int32)
|
Font pitch from post it annotation |
|
size |
integer(int32)
|
Font size from post it annotation. Example: Size:12 is 12000. You need factor 1000 |
|
weight |
integer(int32)
|
Font weight from post it annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
color |
integer(int32)
|
Color of rectangle (32 bit ARGB value) from rectangle annotation Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
colorHexCode |
string
|
Color of rectangle (RGB hexadecimal code) from rectangle annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
createdDate |
string
|
Creation date from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
CreatorId |
|
height |
integer(int32)
|
Height of rectangle in pixel per inch for 7200 DPI |
|
Id |
string
|
Id of the rectangle annotation |
|
modifiedDate |
string
|
Date of modification from rectangle annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from rectangle annotation |
|
securityLevelEnum |
string
|
Security level for rectangle annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if rectangle annotation is selectable by user Values: [, ] |
|
transparent |
boolean
|
Rectangle should be transparent (highlight) Values: [, ] |
|
width |
integer(int32)
|
Width of rectangle in pixel per inch for 7200 DPI |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from rectangle annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from rectangle annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
backgroundColor |
integer(int32)
|
Color of background (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
backgroundColorHexCode |
string
|
Color of background (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
createdDate |
string
|
creation date from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of creator from text annotation |
|
fontInfo |
|
fontInfo |
|
foregroundColor |
integer(int32)
|
Color of the foreground (32 bit ARGB value) from text annotation. Example: Black: -16777216 White: -1 Red: -65536 Green: -16744448 Blue: -16776961 |
|
foregroundColorHexCode |
string
|
Color of foreground (RGB hexadecimal code) from text annotation. Example: Black: #000000 White: #FFFFFF Red: #FF0000 Green: #008000 Blue: #0000FF |
|
height |
integer(int32)
|
Height of text in pixel per inch for 7200 DPI from text annotation |
|
id |
string
|
Id of text annotation |
|
modifiedDate |
string
|
Date of modification from text annotation. Date format: yyyy-MM-ddTHH:mm:ss |
|
pageNumber |
integer(int32)
|
Number of page from text annotation |
|
rotation |
integer(int32)
|
Rotation in degrees from text annotation |
|
securityLevelEnum |
string
|
Security level for text annotation (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default: PubliclyAvailable |
|
selectable |
boolean
|
Defines if text annotation is selectable by user Values: [, ] |
|
text |
string
|
User defined Text of text annotation |
|
transparent |
boolean
|
Text annotation should be transparent Values: [, ] |
|
width |
integer(int32)
|
Width of text in pixel per inch for 7200 DPI from text annotation |
|
x |
integer(int32)
|
X coordinate in pixel per inch for 7200 DPI from text annotation |
|
y |
integer(int32)
|
Y coordinate in pixel per inch for 7200 DPI from text annotation |
Summary:
Description: fontInfo
Properties:
|
Name |
Type |
Summary |
|
isItalic |
boolean
|
Is Font italic from text annotation Values: [, ] |
|
isStrikeOut |
boolean
|
Is font strike out from text annotation Values: [, ] |
|
isUnderline |
boolean
|
Is font underline from text annotation Values: [, ] |
|
name |
string
|
Font name from text annotation. Default: "Arial" |
|
pitch |
integer(int32)
|
Font pitch from text annotation |
|
size |
integer(int32)
|
Font size from text annotation. Example: Size:12 is 12000. You need factor 1000 |
|
weight |
integer(int32)
|
Font weight from text annotation |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createdDate |
string
|
Date on which the Blog was created. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User Id of the creating user blog |
|
id |
string
|
Id of the blog |
|
text |
string
|
Text of blog item |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Id of document data |
|
name |
string
|
Document data name |
|
renditions |
array of (RenditionsItem)
|
renditions |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contentProtections |
array of (ContentProtectionsItem)
|
contentProtections |
|
extension |
string
|
Extension of rendition |
|
files |
array of (FilesItem)
|
files |
|
id |
string
|
id |
|
pageCount |
string
|
Page count of rendition |
|
size |
string
|
Size of rendition |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
blobPath |
string
|
Blob path of rendition |
|
blobStoreId |
string
|
Blob store Id of rendition |
Summary:
Description: lifeCycleManager
Properties:
|
Name |
Type |
Summary |
|
checkOutLifeCycleStateId |
string
|
Checkout life cycle state |
|
lifeCycleEndDate |
string
|
Calculated end date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
lifeCycleStartDate |
string
|
Start date of the life cycle. Date format: yyyy-MM-ddTHH:mm:ss |
|
lifeCycleStateId |
string
|
Id of the LifeCycle state |
|
nextAutomaticLifeCycleStateId |
string
|
Next automatic life cycle state |
|
nextLifeCycleStates |
array of (string)
|
nextLifeCycleStates |
|
lifeCycleProtections |
array of (LifeCycleProtectionsItem)
|
lifeCycleProtections |
|
lifeCycleId |
string
|
Id of the LifeCycle |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
deleteAfterExpiration |
boolean
|
Allow to delete document after protection expiration Values: [, ] |
|
id |
string
|
Id of life cycle state protection |
|
protectAnnotationChange |
boolean
|
Protect against annotation changes Values: [, ] |
|
protectCheckOut |
boolean
|
Protect against check out Values: [, ] |
|
protectContentChange |
boolean
|
Protect against content change Values: [, ] |
|
protectDelete |
boolean
|
Protect against delete Values: [, ] |
|
protectPropertyChange |
boolean
|
Protect against property changes Values: [, ] |
|
protectProtectionDomainChange |
boolean
|
Protect against security change Values: [, ] |
|
protectionDurationTicks |
integer(int32)
|
Duration of protection |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
globalValues |
array of (GlobalValuesItem)
|
globalValues |
|
propertyName |
string
|
Name of property |
|
propertyTypeId |
string
|
Type id of the index field |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
Culture |
|
text |
string
|
Text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
Description for reminder |
|
interval |
integer(int32)
|
Interval in days between reminders |
|
processTemplateId |
string
|
Process template Id for this reminder |
|
reminderDate |
string
|
Date of the reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
reminderId |
string
|
Id of the reminder |
|
subjectIds |
array of (SubjectIdsItem)
|
subjectIds |
|
useUserFromProcessTemplate |
boolean
|
Defines if the user definition from process template will be used Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
ArchiveUrl |
string
|
Url of archive api (e.g.: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId |
string
|
The connection id to identify your connection |
|
ProcessId |
string
|
Id of process (Guid) |
|
AssignUserLoginNames |
string
|
Assign user login names to current task. (e.g.: peter.muster@kendox.com;megan.muster@kendox.com) |
|
ProcessProperties |
string
|
Process properties update format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711;4712;4713 |
|
CustomProperties |
string
|
Custom properties. Format: [<PropertyName>|<PropertyValue>|PropertyType] (e.g. [Supplier|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Number]) |
|
Comment |
string
|
Comment |
|
Culture |
string
|
The culture in which the property names are given (de, en, fr, ...). Default is de |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accessRightsEnumList |
array of (string)
|
accessRightsEnumList |
|
checkOutStateEnum |
string
|
Check out state of the process (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null): |
|
checkOutUserId |
string
|
Id of the user for which document is checked out |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completed date of the process Date format: yyyy-MM-ddTHH:mm:ss |
|
completedTasks |
array of (CompletedTasksItem)
|
completedTasks |
|
createdDate |
string
|
Creation date of the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
currentTask |
|
currentTask |
|
customProperties |
array of (CustomPropertiesItem)
|
customProperties |
|
documentIds |
array of (string)
|
documentIds |
|
dueDate |
string
|
Due date for the process. Date format: yyyy-MM-ddTHH:mm:ss |
|
folderElementId |
string
|
Id of document as folder element |
|
hasLinks |
boolean
|
Id of document as folder element Values: [, ] |
|
id |
string
|
Process id |
|
name |
|
name |
|
priorityEnum |
string
|
Priority of process (High, Normal, Low) |
|
pluginStream |
string
|
Data container for plugins |
|
processTemplateId |
string
|
Process template id |
|
properties |
array of (PropertiesItem)
|
properties |
|
protectionDomainId |
string
|
Protection domain id of process |
|
sessionCount |
integer(int32)
|
Session count |
|
statusEnum |
string
|
Status of process (Open, InProcess, Complete, PreparedToComplete, Error) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
User id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
array of (AssignedUserIdsItem)
|
assignedUserIds |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds |
array of (string)
|
completedUserIds |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of the creator |
|
description |
string
|
Task description |
|
dueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
array of (IntendedUserIdsItem)
|
intendedUserIds |
|
reminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
Id of user, who has set the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: currentTask
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Action text for the user. Displayed to the end user |
|
assignedUserIds |
array of (string)
|
assignedUserIds |
|
comments |
array of (CommentsItem)
|
comments |
|
completedDate |
string
|
Completion date. Date format: yyyy-MM-ddTHH:mm:ss |
|
completedUserIds |
array of (string)
|
completedUserIds |
|
createdDate |
string
|
Creation date. Date format: yyyy-MM-ddTHH:mm:ss |
|
creatorId |
string
|
User id of the creator |
|
description |
string
|
Task description |
|
dueDate |
string
|
Due date of the task. Date format: yyyy-MM-ddTHH:mm:ss |
|
intendedUserIds |
array of (string)
|
intendedUserIds |
|
reminderDate |
string
|
Date for reminder. Date format: yyyy-MM-ddTHH:mm:ss |
|
requiresAllRecipients |
boolean
|
Defines if all recipients have to close this task Values: [, ] |
|
showCloseTaskDialog |
boolean
|
Show close task dialog at task end Values: [, ] |
|
statusEnum |
string
|
Status of task (Open, InProcess, Complete, PreparedToComplete, Error) |
|
taskTemplateId |
string
|
Task template id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
date |
string
|
Date of comment |
|
id |
string
|
Id of comment |
|
text |
string
|
User defined comment |
|
userId |
string
|
Id of user, who has set the comment |
Summary:
Description: List of all custom properties
Properties:
|
Name |
Type |
Summary |
Summary:
Description: name
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
The culture in which the text is given (de, en, fr, ...) |
|
text |
string
|
The text for this language |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
globalValues |
array of (GlobalValuesItem)
|
globalValues |
|
propertyTypeId |
string
|
Type id of the index field |
|
values |
array of (string)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
values |
array of (ValuesItem)
|
values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
culture |
string
|
culture |
|
text |
string
|
text |