docuvita API-Dokumentation

Operation	Beschreibung
AddExternalObjectsToMyWorkspace	Adds external objects to personal workspace
AddObjectsToMyWorkspace	Adds external objects to personal workspace
AddToFavorites	Adds objects to personal favorites
AddToMyWorkspace	Adds objects to personal workspace
ChangePassword	Changes the password of an internal user. After a successful change, a new session is established.
ChangeType	Changes the type of a single object, a list of objects or all objects of the specified type
Chat	Sends a chat message
CommentTask	Comments a workflow task
CompleteTask	Completes a workflow task
DeleteAcls	Deletes the specified ACL entries
DeleteDownloads	Deletes existing external downloads.
DeleteNote	Deletes a note. Requires read permission to the base object.
DeleteObjectRelations	Deletes existing links (relations) between objects
DeleteSavedQueries	Deletes saved queries
DeleteStamp	Deletes a stamp. Requires local administrator rights.
DownloadDoc	Retrieves a document published for an external downloader
FileUpload	Perform file uploads (use /fileupload?guid=uploadguid)
GenerateStamp	Generates a stamp for a specific object. Returns the stamp with template processing.
Get2FAInformation	Validates a request for which an extra authentication is needed
Get2FAResponseRequest	Gets a by a two factor authentication validated request from the server
GetAcls	Retrieves the access control lists for the supplied objects
GetActiveUsersessions	Retrieves all active user sessions
GetAllowedObjectTypeIdsForCreation	Returns a dictionary with key:object type id, value: list of object type ids the current user can create as sub object
GetAuthenticationInformation	Retrieves all fields needed for a logon for the authenticationmodul defined by its configurationid
GetAuthenticationModules	Retrieves all possible authenticationmodules for given systemreferenceguid and clientype
GetAutocompleteSuggestions	Retrieves autocomplete values for a given term
GetBackupInformation	Returns information about the current state of backup (running or not)
GetClientConfiguration	Retrieves all configuration values relevant for the client.
GetConfiguration	Retrieves all configuration values (all rows from dwadmin.configuration)
GetDashboard	Retrieves dashboard content, a list of current user's recently viewed/edited documents, task and import counters and a newsfeed. Replaces getdashboardcontent.
GetDashboardContent	Retrieves dashboard content, e.g. list of recently edited documents. DEPRECATED / not called by docuvita clients anymore. Will be removed 2024.
GetDatabaseInformation	Returns information about the current database
GetDocument	Retrieves the specified version of a document (by version id)
GetDownloadOperations	Retrieves download operations for a specific downloadrecipient set
GetDownloadRecipients	Retrieves download recipients for a specific download set
GetDownloads	Retrieves the list of downloads by various filter criteria
GetExportSet	Exports documents and/or objects into a ZIP file
GetFavorites	Retrieves the list of personal favorites
GetFieldTypes	Retrieves the different field types (maps to Fieldtype in dtoObjecttypedefinition)
GetHistory	Retrieves the history (dwadmin.logging) entries for the given object
GetHistoryMetadata	Retrieves the metadata of history entries for the given history entry id (loggingid)
GetHistoryObjectList	Retrieves the last edited or seen objects and or documents
GetList	Retrieves one level of the list view (similar to tree view, but all object types)
GetLookupPluginResultSet	Retrieves the result set for a query from a lookup plugin
GetMailAttachment	Retrieves an attachment of an archived mail, identified by its version id and the attachment name
GetMailPreview	Retrieves details for an archived e-mail document (EML or MSG file format)
GetMyWorkspace	Retrieves the list of personal workspace items (e.g. customer records, project files etc.)
GetMyWorkspaceQuicksearchResults	Retrieves the list of personal workspace items (e.g. customer records, project files etc.)
GetNotes	Retrieves notes by note id or by object id. Requires read permission to the base object
GetObject	Retrieves a single object by id
GetObjectProperties	Retrieves all properties of a single object by id, in an easily displayable list
GetObjectRelations	Retrieves related objects
GetObjecttypeDefinition	Retrieves object type-level defined fields (custom properties)
GetObjecttypes	Retrieves object types
GetQueryResultSet	Retrieves the result set for a query
GetSavedQueries	Retrieves the list of saved queries (or single items) for the currently logged in user.
GetServiceExtensionUploadRoutes	Retrieves all possible upload endpoints in serviceextensions for the current user session
GetStamps	Retrieves stamps for the current user's tenant. Requires local administrator rights.
GetStylesheet	Removes an active session from the server
GetTask	Retrieves a task, usually to allow a user to complete it
GetTasks	Retrieves tasks, either to list a user's upcoming tasks or a specific workflow's details
GetThumbnail	Retrieves a thumbnail preview for the requested document, if available
GetTree	Retrieves one level of the tree view
GetUsersAndGroupsList	Retrieves all users and/or groups of the system (e.g. to assign follow-ups)
GetUserSettings	Retrieves user settings for the logged in user
GetValidationScripts	Removes an active session from the server
GetVersionFulltext	Retrieves extracted full text of a document version
GetVersionList	Retrieves a list of document versions for a single document, or retrieves a single version by id
GetWorkflowDiagram	Retrieves a workflow diagram by ID from the current workflow template, selected from list of dtoWorkflowModel entries
GetWorkflowLog	Gets workflow log entries for a specific workflow
GetWorkflowModelEntries	Retrieves stored WorkflowModel objects (will not return workflow definition, entry only)
GetWorkflows	Retrieves records for existing workflows, stopped or running
GetWorkflowStartProperties	Retrieves all initial properties of a workflow model that need to be set when an instance of this workflow model is started
GetWorkflowValues	Retrieves workflow value records for existing workflows, stopped or running
Info	Shows system and licensing information
MaintenanceLogin	Executes database maintenance login
MaintenanceLogout	Executes database maintenance logout
MigrateOldWorkflows	Transfers old recall workflows
PrepareServiceExtensionUpload	Prepares an service extension upload and caches its information.Returns a UploadGuid
ReadBackupFile	Returns information about an backup
RefreshSession	Refreshes an active session on the server (resets timeout for session expiry)
RegisteredSystems	Retrieves all registered systems on this server (=tenants/clients)
RemoveDeleteFlag	Removes the delete flag on the specified objects
RemoveFromFavorites	Removes objects from personal favorites
RemoveFromMyWorkspace	Removes objects from the personal workspace
RemoveVersionDeleteFlag	Removes a delete flag from a single document version
ResetUserPassword	Resets a user's password to the default value
SaveAdvancedQuery	Stores an advanced or profile query to allow for later re-issuing the query by current user or other group members
SaveSimpleQuery	Stores a query string to allow for re-entering the search term by current user or other group members
SetAcls	Saves the submitted ACL entries
SetDeleteFlag	Sets the delete flag on the specified objects
SetDownload	Creates a new external download for a document
SetFirstRegisteredSystem	Sets the first registered system
SetIndexDirectory	Sets the location where the index is created
SetNote	Saves a new/edited note. Requires read permission to the base object
SetNoteState	Locks or unlocks a note (deletion not possible except for creator). Requires read permission to the base object.
SetObject	Creates or edits an object
SetObjectProperties	Creates or edits an object using a list of object properties, as received via GetObjectProperties
SetObjectRelations	Creates or updates links (relations) between objects
SetParent	Relocates objects to a new parent id
SetStamp	Saves a new/edited stamp. Requires local administrator rights.
SetUserSetting	Stores a user setting for the logged in user
SetVersion	Stores a new document version record to an existing object
SetVersionDeleteFlag	Flags a single document version to be deleted. Can only be used if at least one version remains un-deleted.
SetVersionFulltext	Writes full text data back to a document version for indexing. This allows e.g. OCR'ed fulltext to be corrected.
SetVersionNumber	Sets version number for existing a document version
StartBackup	Starts backup
StartRestore	Starts the restoring of a choosen backupfile
StartWorkflow	Starts a new workflow
StopWorkflow	Stops a running workflow immediately
ToggleTaskCheckoutState	Informs the server that a user has taken or closed (but not completed) a specific task. It remains open for this and/or other users.
TransferOldIndex	Updates the current database
Unlock	Unlocks a document when it has been checked out without the need to check in a new document version
UpdateDatabase	Updates the current database
UserLogin	Creates a new user session
UserLogout	Removes an active session from the server
Validate2FARequest	Validates a request for which an extra authentication is needed

Name	Parameter	Datentyp	Pflicht
ObjectExternalReferences	query	List<string>	No
ObjectTypeId	query	int	No
UserId	query	int	No
SessionGuid	query	Guid	No
Context	query	dvRequestContext	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
SystemReference	form	int	No
ImpersonatedUser	form	int	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
AddedObjectsList	form	List<dtoObjectsBase>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Parentobject	form	int	No
Objecttype	form	int	No
IsLink	form	bool	No
Fulltext	form	string	No
Objectid	form	int	No
Name	form	string	No
Description	form	string	No
Datecreated	form	DateTime	No
Dateedited	form	DateTime?	No
Documentdate	form	DateTime?	No
Usercreated	form	int	No
Useredited	form	int?	No
Deleteflag	form	int	No
Status	form	int?	No
Checkoutuser	form	int?	No
Checkoutlocation	form	string	No
Abspath	form	string	No
Otpath	form	string	No
Fileextension	form	string	No
Versioncount	form	int?	No
Createdusername	form	string	No
Editedusername	form	string	No
Notecount	form	int?	No
Systemreference	form	int	No
Barcode	form	string	No
Documenttype	form	string	No
Voucherdate	form	DateTime?	No
Vouchertype	form	string	No
Vouchernumber	form	string	No
Externalvouchernumber	form	string	No
Transactionkey	form	string	No
Transactiontype	form	string	No
Validfrom	form	DateTime?	No
Validuntil	form	DateTime?	No
Deleteflagsetby	form	int	No
Deleteflagsetdate	form	DateTime?	No
Hiddenflagsetdate	form	DateTime?	No
Deletereason	form	int?	No
Approvalstatuscode	form	int	No
Approvedby	form	int	No
Approvedversion	form	int	No
Latestversion	form	int	No
Filesize	form	int	No
Filehash	form	string	No
Extmetadata	form	string	No
Mailfrom	form	string	No
Mailto	form	string	No
Mailcc	form	string	No
Mailbcc	form	string	No
Mailsubject	form	string	No
Mailmessageid	form	string	No
Mailsenddate	form	DateTime?	No
Mailparentmailid	form	int	No
Activeworkflowcount	form	int	No
Relatedobjectscount	form	int?	No
Deletereasontext	form	string	No
Updateabspath	form	int	No
Lvl	form	int	No
AccessRight	form	int	No

Name	Parameter	Datentyp	Pflicht
ObjectReferences	query	List<dvAddObjectToWorkspaceEntry>	No
UserId	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht
Objecttype	form	int	No
Objectid	form	int	No
Objectextmetadata	form	string	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
AddedObjectsList	form	List<dtoObjectsBase>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Parentobject	form	int	No
Objecttype	form	int	No
IsLink	form	bool	No
Fulltext	form	string	No
Objectid	form	int	No
Name	form	string	No
Description	form	string	No
Datecreated	form	DateTime	No
Dateedited	form	DateTime?	No
Documentdate	form	DateTime?	No
Usercreated	form	int	No
Useredited	form	int?	No
Deleteflag	form	int	No
Status	form	int?	No
Checkoutuser	form	int?	No
Checkoutlocation	form	string	No
Abspath	form	string	No
Otpath	form	string	No
Fileextension	form	string	No
Versioncount	form	int?	No
Createdusername	form	string	No
Editedusername	form	string	No
Notecount	form	int?	No
Systemreference	form	int	No
Barcode	form	string	No
Documenttype	form	string	No
Voucherdate	form	DateTime?	No
Vouchertype	form	string	No
Vouchernumber	form	string	No
Externalvouchernumber	form	string	No
Transactionkey	form	string	No
Transactiontype	form	string	No
Validfrom	form	DateTime?	No
Validuntil	form	DateTime?	No
Deleteflagsetby	form	int	No
Deleteflagsetdate	form	DateTime?	No
Hiddenflagsetdate	form	DateTime?	No
Deletereason	form	int?	No
Approvalstatuscode	form	int	No
Approvedby	form	int	No
Approvedversion	form	int	No
Latestversion	form	int	No
Filesize	form	int	No
Filehash	form	string	No
Extmetadata	form	string	No
Mailfrom	form	string	No
Mailto	form	string	No
Mailcc	form	string	No
Mailbcc	form	string	No
Mailsubject	form	string	No
Mailmessageid	form	string	No
Mailsenddate	form	DateTime?	No
Mailparentmailid	form	int	No
Activeworkflowcount	form	int	No
Relatedobjectscount	form	int?	No
Deletereasontext	form	string	No
Updateabspath	form	int	No
Lvl	form	int	No
AccessRight	form	int	No

Name	Parameter	Datentyp	Pflicht
ObjectIds	query	List<int>	No
UserId	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
ObjectIds	query	List<int>	No
UserId	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
AddedObjectsList	form	List<dtoObjectsBase>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Parentobject	form	int	No
Objecttype	form	int	No
IsLink	form	bool	No
Fulltext	form	string	No
Objectid	form	int	No
Name	form	string	No
Description	form	string	No
Datecreated	form	DateTime	No
Dateedited	form	DateTime?	No
Documentdate	form	DateTime?	No
Usercreated	form	int	No
Useredited	form	int?	No
Deleteflag	form	int	No
Status	form	int?	No
Checkoutuser	form	int?	No
Checkoutlocation	form	string	No
Abspath	form	string	No
Otpath	form	string	No
Fileextension	form	string	No
Versioncount	form	int?	No
Createdusername	form	string	No
Editedusername	form	string	No
Notecount	form	int?	No
Systemreference	form	int	No
Barcode	form	string	No
Documenttype	form	string	No
Voucherdate	form	DateTime?	No
Vouchertype	form	string	No
Vouchernumber	form	string	No
Externalvouchernumber	form	string	No
Transactionkey	form	string	No
Transactiontype	form	string	No
Validfrom	form	DateTime?	No
Validuntil	form	DateTime?	No
Deleteflagsetby	form	int	No
Deleteflagsetdate	form	DateTime?	No
Hiddenflagsetdate	form	DateTime?	No
Deletereason	form	int?	No
Approvalstatuscode	form	int	No
Approvedby	form	int	No
Approvedversion	form	int	No
Latestversion	form	int	No
Filesize	form	int	No
Filehash	form	string	No
Extmetadata	form	string	No
Mailfrom	form	string	No
Mailto	form	string	No
Mailcc	form	string	No
Mailbcc	form	string	No
Mailsubject	form	string	No
Mailmessageid	form	string	No
Mailsenddate	form	DateTime?	No
Mailparentmailid	form	int	No
Activeworkflowcount	form	int	No
Relatedobjectscount	form	int?	No
Deletereasontext	form	string	No
Updateabspath	form	int	No
Lvl	form	int	No
AccessRight	form	int	No

Name	Parameter	Datentyp	Pflicht
SystemReferenceId	query	int	No
UserName	query	string	No
OldUserPassword	query	string	No
NewUserPassword	query	string	No
SessionType	query	int	No
AuthenticationModuleConfigurationId	query	int	No
AuthenticationInformation	query	IList<AuthenticationInformationValue>	No
UiCulture	query	string	No
DownloadDocumentIdentifier	query	string	No

Name	Parameter	Datentyp	Pflicht
Masked	form	bool	No
IsReactivationToken	form	bool	No
IsReactivationTokenIndicator	form	bool	No

Name	Parameter	Datentyp	Pflicht
FieldId	form	int	No
FieldName	form	string	No
FieldPrompt	form	string	No
FieldFormat	form	string	No
FieldDescription	form	string	No
FieldDocumentation	form	string	No
FieldType	form	string	No
MultiLine	form	bool	No
FieldValueString	form	string	No
FieldValueDateTime	form	DateTime?	No
FieldValueNumeric	form	int?	No
FieldValueBool	form	bool?	No
FieldValueCurrency	form	double?	No
Position	form	int	No
Category	form	string	No
Required	form	bool	No
LookupValuesOnly	form	bool	No
LookupValues	form	string[]	No
ReadOnly	form	bool	No
Visible	form	bool	No
IsListType	form	bool	No
ClearBeforeShow	form	bool	No
FieldLookupType	form	dvFieldLookupType	No
FieldLookupFilter	form	string[]	No
FieldLookupPluginName	form	string	No
FieldLookupValueMapping	form	string	No
FieldLookupPluginFilter	form	string	No
FieldLookupPluginListener	form	string	No
Masked	form	bool	No
ListValuesString	form	string[]	No
ListValuesDateTime	form	Nullable<DateTime>[]	No
ListValuesNumeric	form	Nullable<Int32>[]	No
ListValuesBool	form	Nullable<Boolean>[]	No
ListValuesCurrency	form	Nullable<Double>[]	No
CustomFunctions	form	string[]	No
CustomRenderer	form	string	No
Dirty	form	bool	No

Name	Parameter	Datentyp	Pflicht
Usersession	form	dtoUsersessions	No
DownloadDocumentIdentifier	form	string	No
DownloadDocumentToken	form	string	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Sessionid	form	int	No
Systemreference	form	int	No
Sessionguid	form	string	No
Sessiontype	form	int	No
UiCulture	form	string	No
User	form	int	No
Userloginname	form	string	No
Useremail	form	string	No
Usergroup	form	int	No
Usergroupname	form	string	No
Sessionstarted	form	DateTime	No
Lastactivity	form	DateTime	No
Hostip	form	string	No
IsAdmin	form	int	No
IsImportAdmin	form	int	No
IsBatchDeletionAdmin	form	int	No
IsWorkflowAdmin	form	int	No
ReactivationToken	form	string	No
DisconnectionInterval	form	int	No
Workflowuserstatus	form	int	No
AuthenticationModuleConfigurationId	form	int	No
IsRightsAdmin	form	int	No
IsConstraintsAdmin	form	int	No
IsWorkflowRolesAdmin	form	int	No
IsWorkflowMonitor	form	int	No
Sessionstate	form	int	No

Name	Parameter	Datentyp	Pflicht
ObjectPropertyList	query	IList<dvObjectProperty>	No
TypeChangeComment	query	string	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht
FieldId	form	int	No
FieldName	form	string	No
FieldPrompt	form	string	No
FieldFormat	form	string	No
FieldDescription	form	string	No
FieldDocumentation	form	string	No
FieldType	form	string	No
MultiLine	form	bool	No
FieldValueString	form	string	No
FieldValueDateTime	form	DateTime?	No
FieldValueNumeric	form	int?	No
FieldValueBool	form	bool?	No
FieldValueCurrency	form	double?	No
Position	form	int	No
Category	form	string	No
Required	form	bool	No
LookupValuesOnly	form	bool	No
LookupValues	form	string[]	No
ReadOnly	form	bool	No
Visible	form	bool	No
IsListType	form	bool	No
ClearBeforeShow	form	bool	No
FieldLookupType	form	dvFieldLookupType	No
FieldLookupFilter	form	string[]	No
FieldLookupPluginName	form	string	No
FieldLookupValueMapping	form	string	No
FieldLookupPluginFilter	form	string	No
FieldLookupPluginListener	form	string	No
Masked	form	bool	No
ListValuesString	form	string[]	No
ListValuesDateTime	form	Nullable<DateTime>[]	No
ListValuesNumeric	form	Nullable<Int32>[]	No
ListValuesBool	form	Nullable<Boolean>[]	No
ListValuesCurrency	form	Nullable<Double>[]	No
CustomFunctions	form	string[]	No
CustomRenderer	form	string	No
Dirty	form	bool	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ObjectsElement	form	dtoObjectsBase	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Parentobject	form	int	No
Objecttype	form	int	No
IsLink	form	bool	No
Fulltext	form	string	No
Objectid	form	int	No
Name	form	string	No
Description	form	string	No
Datecreated	form	DateTime	No
Dateedited	form	DateTime?	No
Documentdate	form	DateTime?	No
Usercreated	form	int	No
Useredited	form	int?	No
Deleteflag	form	int	No
Status	form	int?	No
Checkoutuser	form	int?	No
Checkoutlocation	form	string	No
Abspath	form	string	No
Otpath	form	string	No
Fileextension	form	string	No
Versioncount	form	int?	No
Createdusername	form	string	No
Editedusername	form	string	No
Notecount	form	int?	No
Systemreference	form	int	No
Barcode	form	string	No
Documenttype	form	string	No
Voucherdate	form	DateTime?	No
Vouchertype	form	string	No
Vouchernumber	form	string	No
Externalvouchernumber	form	string	No
Transactionkey	form	string	No
Transactiontype	form	string	No
Validfrom	form	DateTime?	No
Validuntil	form	DateTime?	No
Deleteflagsetby	form	int	No
Deleteflagsetdate	form	DateTime?	No
Hiddenflagsetdate	form	DateTime?	No
Deletereason	form	int?	No
Approvalstatuscode	form	int	No
Approvedby	form	int	No
Approvedversion	form	int	No
Latestversion	form	int	No
Filesize	form	int	No
Filehash	form	string	No
Extmetadata	form	string	No
Mailfrom	form	string	No
Mailto	form	string	No
Mailcc	form	string	No
Mailbcc	form	string	No
Mailsubject	form	string	No
Mailmessageid	form	string	No
Mailsenddate	form	DateTime?	No
Mailparentmailid	form	int	No
Activeworkflowcount	form	int	No
Relatedobjectscount	form	int?	No
Deletereasontext	form	string	No
Updateabspath	form	int	No
Lvl	form	int	No
AccessRight	form	int	No

Name	Parameter	Datentyp	Pflicht
ChatMessage	query	string	No
ChatRecipientUser	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Taskid	query	int	No
Taskcomment	query	string	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Taskid	query	int	No
TaskProperties	query	IList<dvObjectProperty>	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht
FieldId	form	int	No
FieldName	form	string	No
FieldPrompt	form	string	No
FieldFormat	form	string	No
FieldDescription	form	string	No
FieldDocumentation	form	string	No
FieldType	form	string	No
MultiLine	form	bool	No
FieldValueString	form	string	No
FieldValueDateTime	form	DateTime?	No
FieldValueNumeric	form	int?	No
FieldValueBool	form	bool?	No
FieldValueCurrency	form	double?	No
Position	form	int	No
Category	form	string	No
Required	form	bool	No
LookupValuesOnly	form	bool	No
LookupValues	form	string[]	No
ReadOnly	form	bool	No
Visible	form	bool	No
IsListType	form	bool	No
ClearBeforeShow	form	bool	No
FieldLookupType	form	dvFieldLookupType	No
FieldLookupFilter	form	string[]	No
FieldLookupPluginName	form	string	No
FieldLookupValueMapping	form	string	No
FieldLookupPluginFilter	form	string	No
FieldLookupPluginListener	form	string	No
Masked	form	bool	No
ListValuesString	form	string[]	No
ListValuesDateTime	form	Nullable<DateTime>[]	No
ListValuesNumeric	form	Nullable<Int32>[]	No
ListValuesBool	form	Nullable<Boolean>[]	No
ListValuesCurrency	form	Nullable<Double>[]	No
CustomFunctions	form	string[]	No
CustomRenderer	form	string	No
Dirty	form	bool	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
SecurityIdList	query	List<int>	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
DownloadIds	query	List<int>	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
NoteId	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
SourceObjectId	query	int	No
RelatedObjectIds	query	List<int>	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
UsersAndQueriesIds	query	List<int>	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
StampId	query	int	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
DownloadDocIdentifier	path	string	No	Identifier for external download (guid or named)
DownloadDocToken	path	string	No	Onetime token for verifying external download (guid or named)

Name	Parameter	Datentyp	Pflicht	Beschreibung
Options	form	IDictionary<string, string>	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
Guid	body	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
StampId	query	int	No
ObjectId	query	int	No
InputStamp	query	dtoStamps	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht
Stampid	form	int	No
Name	form	string	No
Template	form	string	No
Thumbnail	form	string	No
Systemreference	form	int	No
Isactive	form	int	No
Position	form	int	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResultStamp	form	dtoStamps	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
TwoFactorToken	query	string	No

Name	Parameter	Datentyp	Pflicht
ObjectIdList	query	List<int>	No
IncludeSystemAcls	query	bool	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
AclList	form	IList<dtoAclsecurity>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Securityid	form	int	No
Secobject	form	int	No
Secuser	form	int	No
Secrule	form	int	No
Sectype	form	int	No
Secright	form	int	No
Validfrom	form	DateTime	No
Validto	form	DateTime	No
Datecreated	form	DateTime	No
Usercreated	form	int	No
Createdusername	form	string	No
Dateedited	form	DateTime?	No
Useredited	form	int?	No
Editedusername	form	string	No
SecuserObject	form	dtoObjectsBase	No
SecruleObject	form	dtoConstr	No

Name	Parameter	Datentyp	Pflicht
Constrid	form	int	No
Constraintname	form	string	No
Objecttype	form	int	No
Constrainttype	form	string	No
Systemreference	form	int	No
Constritems	form	IList<dtoConstritems>	No
Extendedconstr	form	dvExtendedRuleElement	No
Constrstatus	form	int	No
IsHierarchic	form	bool	No

Name	Parameter	Datentyp	Pflicht
Constraintitemid	form	int	No
Constr	form	int	No
Position	form	int	No
Andor	form	int	No
Field	form	int	No
Operator	form	string	No
Value	form	string	No

Name	Parameter	Datentyp	Pflicht
RuleElementType	form	dvExtendedRuleElementType	No
Field	form	string	No
Operator	form	string	No
Values	form	List<string>	No
SubItems	form	IList<dvExtendedRuleElement>	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
Usersessions	form	List<dtoUsersessions>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
AllowedTypesDictionary	form	Dictionary<int, List<Int32>>	No
AllowedLocationTypesDictionary	form	Dictionary<int, List<Int32>>	No
AllowedWorkflowsDictionary	form	Dictionary<int, List<dtoWorkflowmodel>>	No
AllowedWorkflowsToMonitor	form	List<dtoWorkflowmodel>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
Workflowmodelid	form	int	No	ID of this workflow model in the database. This is the unique identifier to retrieve the workflow model inside the system.
Workflowmodelguid	form	Guid	No
Systemreference	form	int	No
Workflowmodelversion	form	int	No
Enabled	form	bool	No	Flag to specify if workflow model is generally enabled or not. In case it is disabled, no further workflows of this model can be started, even if registrations to user/group/role and object type are present. However disabling the workflow model does not affect workflows of this model that are currently running.
Name	form	string	No
Displayname	form	string	No
Description	form	string	No
Category	form	string	No
Datecreated	form	DateTime	No	Date of creation of this workflow model. Mandatory property
Dateedited	form	DateTime?	No	Date of last manipulation of this workflow model. Optional property
Usercreated	form	int	No	id of the user (=object id) who created the workflow model. Mandatory property
Useredited	form	int?	No	id of the user who performed the last manipulation of the workflow model. Optional property
Createdusername	form	string	No	Name of the user who created the workflow model (non-normalized for display performance, see Usercreated)
Editedusername	form	string	No	Name of the user who performed the last manipulation of the workflow model (non-normalized for display performance, see Useredited)
Workflowmodeltype	form	int	No	Type of workflow model. Supported values are: 0: default (user) workflow 1: system workflow (cannot be added/modified/deleted manually)

Name	Parameter	Datentyp	Pflicht
AuthenticationModuleConfigurationId	query	int	No
ClientType	query	int	No
ExternalLoginPhase	query	int	No
ExternalLoginContext	query	Guid	No

Name	Parameter	Datentyp	Pflicht
Values	form	List<AuthenticationInformationValue>	No
SessionType	form	int	No
UiCulture	form	string	No
SessionGuid	form	Guid	No
LogoutExistingSession	form	bool	No
CallingIpAddress	form	string	No

Name	Parameter	Datentyp	Pflicht
RegisteredSystem	query	int	No
ClientType	query	int	No
AuthenticationConfigurationFilter	query	AuthenticationModuleConfigurationFilter	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResultList	form	IList<dtoAuthenticationmoduleconfiguration>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Configurationid	form	int	No
Systemreference	form	int	No
Systemalias	form	string	No
Systemname	form	string	No
Authenticationmoduleclass	form	string	No
Authenticationmodulename	form	string	No
Authenticationmoduledescription	form	string	No
Configuration	form	string	No
Isactive	form	int	No
Position	form	int	No
ShowInLoginScreen	form	bool	No
CanChangePassword	form	bool	No
Allowednetworks	form	string	No
Blockednetworks	form	string	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
SuggestionList	form	IList<string>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
BackupManagerState	form	BackupManagerOperationState	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
ConfigurationList	form	IList<dtoConfiguration>	No
ServiceExtensionUploadRoutes	form	IList<dtoServiceextensionuploadroute>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Application	form	string	No
Section	form	string	No
Key	form	string	No
Value	form	string	No
Description	form	string	No

Name	Parameter	Datentyp	Pflicht
ServiceExtensionName	form	string	No
UploadRoute	form	string	No
CommandText	form	string	No
CommandTitle	form	string	No
CommandDescription	form	string	No
ScanFileTypes	form	int	No
BarcodeSettings	form	BarcodeParserSettings	No
BarcodeObjecttype	form	int	No
BarcodeObjecttypeDefintion	form	int	No
BarcodeDisplayPathSelector	form	string	No
BarcodeFieldName	form	string	No

Name	Parameter	Datentyp	Pflicht
ScanInterval	form	int	No
ExpectedBarcodes	form	int	No
AutomaticRecognition	form	bool	No
RenderPdfPages	form	bool	No
ConvertToPdf	form	bool	No
BarcodeParserList	form	List<SingleBarcodeParserSettings>	No
ConvertToBitonal	form	bool	No
AppendMultipleMatchedBarcodes	form	bool	No
SkipBlankPages	form	bool	No
SkipPagesWithoutMatchingBarcodes	form	bool	No
GatherTestResults	form	bool	No
MarkDocAsPdfA	form	bool?	No
RenderPdfAndImport	form	bool?	No

¶ Inhalt

¶ Allgemeine Operationen

¶ AddExternalObjectsToMyWorkspace

¶ AddObjectsToMyWorkspace

¶ AddToFavorites

¶ AddToMyWorkspace

¶ ChangePassword

¶ ChangeType

¶ Chat

¶ CommentTask

¶ CompleteTask

¶ DeleteAcls

¶ DeleteDownloads

¶ DeleteNote

¶ DeleteObjectRelations

¶ DeleteSavedQueries

¶ DeleteStamp

¶ DownloadDoc

¶ FileUpload

¶ GenerateStamp

¶ Get2FAInformation

¶ Get2FAResponseRequest

¶ GetAcls

¶ GetActiveUsersessions

¶ GetAllowedObjectTypeIdsForCreation

¶ GetAuthenticationInformation

¶ GetAuthenticationModules

¶ GetAutocompleteSuggestions

¶ GetBackupInformation

¶ GetClientConfiguration

¶ GetConfiguration

¶ GetDashboard

¶ GetDashboardContent

¶ GetDatabaseInformation

¶ GetDocument

¶ GetDownloadOperations

¶ GetDownloadRecipients

¶ GetDownloads

¶ GetExportSet

¶ GetFavorites

¶ GetFieldTypes

¶ GetHistory

¶ GetHistoryMetadata

¶ GetHistoryObjectList

¶ GetList

¶ GetLookupPluginResultSet

¶ GetMailAttachment

¶ GetMailPreview

¶ GetMyWorkspace

¶ GetMyWorkspaceQuicksearchResults

¶ GetNotes

¶ GetObject

¶ GetObjectProperties

¶ GetObjectRelations

¶ GetObjecttypeDefinition

¶ GetObjecttypes

¶ GetQueryResultSet

¶ GetSavedQueries

¶ GetServiceExtensionUploadRoutes

¶ GetStamps

¶ GetStylesheet

¶ GetTask

¶ GetTasks

¶ GetThumbnail

¶ GetTree

¶ GetUsersAndGroupsList

¶ GetUserSettings

¶ GetValidationScripts

¶ GetVersionFulltext

¶ GetVersionList

¶ GetWorkflowDiagram

¶ GetWorkflowLog

¶ GetWorkflowModelEntries

¶ GetWorkflows

¶ GetWorkflowStartProperties

¶ GetWorkflowValues

¶ Info

¶ MaintenanceLogin

¶ MaintenanceLogout

¶ MigrateOldWorkflows

Name	Parameter	Datentyp	Pflicht
MyRecentDocumentsList	form	IList<dtoObjectsBase>	No
Counters	form	Dictionary<string, int>	No
NewsItems	form	IList<DashboardNewsItem>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Title	form	string	No
Content	form	string	No
DatePublished	form	DateTime	No
ImageBase64	form	string	No
SourceLink	form	string	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
DashboardContentType	query	dvDashboardType	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht
MyRecentlyEditedObjectsList	form	IList<dtoObjectsBase>	No
MyRecentlyEditedDocumentsList	form	IList<dtoObjectsBase>	No
RecentlyEditedObjectsList	form	IList<dtoObjectsBase>	No
RecentlyEditedDocumentsList	form	IList<dtoObjectsBase>	No
MyRecentlySeenObjectsList	form	IList<dtoObjectsBase>	No
MyRecentlySeenDocumentsList	form	IList<dtoObjectsBase>	No
TaskResultList	form	IList<dtoTask>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Taskid	form	int	No
Workflow	form	int	No
Tasktemplate	form	string	No
Tasktemplatetype	form	int	No
Taskformtype	form	int	No
Taskformdefinition	form	string	No
Tasksystemstate	form	int	No
Taskcomment	form	string	No
Taskdisplayname	form	string	No
Taskdescription	form	string	No
Datecreated	form	DateTime	No
Datelastactivity	form	DateTime	No
Userlastactivity	form	int	No
Lastactivityusername	form	string	No
Taskresult	form	string	No
Taskdisplayoptions	form	int	No
Lastactivityuseremail	form	string	No
Taskformhtml	form	string	No
Datestarted	form	DateTime	No
Duedate	form	DateTime?	No
Reminddate	form	DateTime?	No
Timeoutdate	form	DateTime?	No
Datesentreminder	form	DateTime?	No
Datecompleted	form	DateTime?	No
Workflow_Workflowname	form	string	No
Workflow_Workflowdisplayname	form	string	No
Workflow_Workflowdescription	form	string	No
Workflow_Workflowmodelid	form	int	No
Workflow_Workflowmodeltype	form	int	No
Workflow_Workflowmodelguid	form	Guid	No
Workflow_Firstobjectid	form	int	No
Workflow_Firstobjecttypeid	form	int	No
Workflow_Firstobjectelement	form	dtoObjectsBase	No
Workflow_Datecreated	form	DateTime	No
Workflow_Usercreated	form	int	No
Workflow_Createdusername	form	string	No
Workflow_Datelastactivity	form	DateTime	No
Workflow_Userlastactivity	form	int	No
Workflow_Lastactivityusername	form	string	No

Name	Parameter	Datentyp	Pflicht
DatabaseInformation	form	dtoDatabaseinformation	No
DatabaseManagerState	form	DatabaseManagerOperationState	No
DatabaseLanguages	form	string[]	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Databaseexists	form	bool	No
Isdocuvitadatabase	form	bool	No
Isemptydatabase	form	bool	No
Cancreatedatabase	form	bool	No
Version	form	dtoProductversion	No
Engine	form	DatabaseEngine	No
Name	form	string	No
Connectionstring	form	string	No
Administrationconnectionstring	form	string	No
UpdateOrCreatePossible	form	bool	No
IndexDirectory	form	string	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
VersionId	query	int	No	Specifies the version id to download
ObjectId	query	int	No
CheckOut	query	bool	No
DownloadAsAttachment	query	bool	No
DownloadPreviewDocument	query	bool	No
Comment	query	string	No
DownloadPurpose	query	dvGetDocumentPurpose	No
SessionGuid	query	Guid	No

Name	Parameter	Datentyp	Pflicht	Beschreibung
ResultList	form	IList<dtoDownloadoperations>	No
ResponseStatus	form	ResponseStatus	No

Name	Parameter	Datentyp	Pflicht
Downloadoperationid	form	int	No
Downloadrecipient	form	int	No
Datedownloaded	form	DateTime	No
Agent	form	string	No
Ip	form	string	No
Downloadoperationstatus	form	int	No