Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Web API Reference

The Web API Reference provides descriptions of all operations in the Therefore™ Web Application Programming Interface (WebAPI). Operations can be categorized by problem area.

Case operations
CloseCase	POST	Closes the case with given case ID.
CreateCase	POST	Creates a new case, defines index data for the case and returns the case number.
DeleteCase	POST	Deletes the case with the specified case number.
GetCase	POST	Gets the case with the specified case number.
GetCaseDefinition	POST	Gets the case definition from the server.
GetCaseDocuments	POST	Gets a list of document numbers contained in the case (and a specified category).
GetCaseHistory	POST	Returns the history of the case.
ReopenCase	POST	Reopens a closed case.
SaveCaseIndexData	POST	Updates the case index data.
SaveCaseIndexDataQuick	POST	Updates index data of an existing Therefore™ case quickly, without specifying LastChangeTime. This method allows to update any index data fields except table fields. Updating the table fields without specifying LastChangeTime is unsafe.

Category operations
GetCategoriesTree	POST	Returns tree of the categories.
GetCategoryInfo	POST	Returns the definition of Therefore™ category.

Document operations
AddStreamsToDocument	POST	Adds file streams to an existing Therefore™ document. Conversion options for the documents can be specified.
CheckInDocument	POST	Checks in the updated document.
CheckOutDocument	POST	Checks out the document.
CreateDocument	POST	Creates and archives a new Therefore™ document to a category as well as auto-append documents to existing ones; the operation can also be used to create a new document for the case (using a built-in CaseNo index data field).
CreateLinkFile	POST	Creates and returns a new Therefore™ compound file that contains a link to a Therefore™ document.
DeleteDocument	POST	Deletes an existing Therefore™ document with the specified document number.
DeleteOfficeDocumentInCloud	POST	Deletes office document in the cloud.
EditOfficeDocumentInCloud	POST	Uploads given office document to the cloud for editing. Returns links to the uploaded file.
FillDependentFields	POST	If user-defined data types are used (foreign tables) this method will look up all referenced entries in foreign tables and fill in the dependent fields. If calculated fields exist this method will recalculate them. Updated index data fields are returned in response.
FinishedEditingOfficeDocumentInCloud	POST	Finishes editing for given office document in the cloud and returns file session id for the document.
GetConvertedDocStreams	POST	Returns file streams of existing Therefore™ document and converts them into the desired format.
GetConvertedDocStreamsRaw	POST	Returns file streams of existing Therefore™ document and converts them into the desired format. NOTE: If output of the conversion process contains many files only first file will be returned. If there are no streams in the document empty stream/array will be returned.
GetDocument	POST	Returns the Therefore™ document from the server.
GetDocumentCheckoutStatus	POST	Returns check-out status of existing Therefore™ document.
GetDocumentHistory	POST	Returns the history of the specified Therefore™ document.
GetDocumentIndexData	POST	Returns index data of an existing Therefore™ document.
GetDocumentProperties	POST	Returns properties of existing Therefore™ document.
GetDocumentStream	POST	Returns the file stream of an existing Therefore™ document for any version of the document.
GetDocumentStreamFile	GET	Gets a file of a document by given document/version/stream numbers. Tenant Name or 'default' for a single tenant system. Document number. Document version number. Use 0 (zero) for latest version. Number of a file stream inside the document (zero based).
GetDocumentStreamRaw	POST	Returns the file stream of an existing Therefore™ document for any version of the document.
GetOfficeDocumentsInCloud	POST	Returns list of office documents uploaded to the cloud for given document number by current user.
GetThumbnail	POST	Returns the thumbnail of an existing Therefore™ document.
PreprocessIndexData	POST	Returns index data for given category (with default values, filled dependent fields, or with ix data for autoappend, and updated calculated fields).
PreprocessTableRow	POST	Returns index data for given table row (with default values, filled dependent fields).
RevertEditedOfficeDocumentsInCloud	POST	Reverts any changes made to the given office document and deletes it in the cloud if any.
SaveDocumentIndexData	POST	Updates index data of an existing Therefore™ document.
SaveDocumentIndexDataQuick	POST	Updates index data of an existing Therefore™ document quickly, without specifying LastChangeTime. This method allows to update any index data fields except table fields. Updating the table fields without specifying LastChangeTime is unsafe.
StartCreateDocumentBatch	POST	Starts a batch operation to create and archive a new Therefore™ document.
StartUpdateDocumentBatch	POST	Starts a batch operation to update a Therefore™ document.
SubmitCreateDocumentBatch	POST	Submits an operation to create and archive a new Therefore™ document.
SubmitUpdateDocumentBatch	POST	Submits an operation to update a Therefore™ document.
TestCheckOutDocument	POST	Tests if check out is possible for given document.
UndoCheckOutDocument	POST	Frees the locked document so that other users may check it out. All changes are lost.
UpdateDocument	POST	Updates an existing Therefore™ document.
UploadDocStreamToBatch	POST	Uploads a file for a given batch operation.
ValidateFields	POST

EForms operations
CopyEForm	POST	Copies an eForm and all related child objects
DeleteEForm	POST	Saves or updates an EForm in Therefore.
DeleteEFormDraftSubmission	POST	Delete an eForm draft in Therefore
GetEForm	POST	Loads an EForm from Therefore
GetEFormAccessToken	POST	Gets an anonymous access token to fill out an eForm
GetUploadedEFormFile	GET	Get a previously saved eForm attachment file for viewing Tenant name Field Id
SaveEForm	POST	Saves or updates an EForm in Therefore.
SaveEFormDefaultSubmission	POST	Save default submission data for an eForm
SaveEFormDraft	POST	Save an eForm draft to Therefore
SearchEFormSubmission	POST	Search saved eForm submissions for current user
SubmitEForm	POST	Loads an EForm from Therefore
UploadEFormFile	POST	Upload a file to be saved as attachment to an eForm. HTTP header param: x-the-name.
VerifyReCaptchaToken	POST	Returns information about connected user.

Folder operations
DeleteFolder	POST	Delete a folder from Therefore
GetFolder	POST	Load information about a folder
SaveFolder	POST	Save a new folder to Therefore
SetParentFolder	POST	Move a folder to another parent folder

Keyword operations
AddDictionaryKeyword	POST	Adds a new keyword to the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo.
DeleteDictionaryKeyword	POST	Deletes the keyword from the keyword dictionary. A keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo.
GetDictionaryInfo	POST	Gets detailed information for the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo.
GetKeywordsByFieldNo	POST	Gets a list of keywords for the index data of the specified field.
GetKeywordsByKeyDic	POST	Gets a list of keywords for the keyword dictionary of the specified field.
UpdateDictionaryKeyword	POST	Updates the keyword name and/or activated status in the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo.
ValidateKeywords	POST	Validates keywords for a specified index data field.

Link operations
CreateNewManualLink	POST	Creates a the link between two documents/cases.
GetLinkedObjects	POST	Gets a list of the objects linked to a given object.
GetLinkedWorkflowsForDoc	POST	Gets list of workflow for given document.
LinkCases	POST	DEPRECATED: Use the CreateNewManualLink method instead. Creates the link between two cases.
LinkCaseToDocument	POST	Creates new link between a document and a case.
LinkDocAndWFInstance	POST	Creates the link between the document and the workflow instance.
LinkDocuments	POST	DEPRECATED: Use the CreateNewManualLink method instead. Creates the link between two documents.
RemoveManualLink	POST	Creates a the link between two documents/cases.
UnlinkCases	POST	DEPRECATED: Use the RemoveManualLink method instead. Removes the link between two cases.
UnlinkDocAndWFInstance	POST	Removes the document link to a Therefore™ document from the workflow instance.
UnlinkDocuments	POST	DEPRECATED: Use the RemoveManualLink method instead. Removes the link between two documents.

Other operations
ClearLocalCache	POST	Clear local WebAPI cache
CreateWorkflowUserInboxSubscription	POST	Creates a new workflow user inbox notification subscription.
DeletePortalUser	POST	Deletes given portal user.
EraseAllObjects	POST	Erases deleted documents and cases from the system.
EraseObjects	POST	Erases specified objects from the system.
ExecuteRecycleBinQuery	POST	Executes the query returning deleted Therefore™ documents and cases.
GenerateWebRefererenceNo	POST	Generates encrypted web refernce number. Use it to encrypt the Therefore™ case, document, workflow instance, workflow process and task numbers for HTTP/HTTPS links used by Therefore™ Web Access.
GetAllTreeViews	POST	Gets a list of tree view items for specific permissions.
GetClientDiscoveryInfo	POST	Loads discovery/connection information/settings from server
GetConnectionToken	POST	Returns connection token for provided user credentials.
GetConnectionTokenFromADFSToken	POST	Returns connection token for provided ADFS token.
GetDomainInfo	POST	Gets the name of the default domain and a list of all valid domain names from the server.
GetJWTToken	POST	Returns JSON Web Token (JWT) for provided user credentials.
GetNotificationSubscriptions	POST	Gets all notification subscription guids for this user
GetObjectRights	POST	Gets the permissions of a specified object. Please see also operation GetPermissionConstants.
GetObjects	POST	Gets a list of a specified object from the server.
GetObjectsList	POST	Gets a list of a specified object from the server.
GetPermissionConstants	POST	DEPRECATED: Use the GetRolePermissionConstants method instead. Gets a list of permission constants defined on the server.
GetPermissions	POST	DEPRECATED: Use the GetRolePermissions method instead. Gets the permission list directly set for the user on the specified object.
GetPublicSettingInt	POST	Gets the value of a integer public setting by the key.
GetPublicSettingString	POST	Gets the value of a string public setting by the key.
GetReferencedTableInfo	POST	Get technical information about the table to query in Therefore
GetRoleAssignments	POST	Gets list of assignments of roles to users on one Therefore™ object.
GetRolePermissionConstants	POST	Gets a list of role-based permission constants defined on the server.
GetRolePermissions	POST	Gets the role-based permissions set for the connected user on the specified object. See also: operation GetRolePermissionConstants.
GetRoles	POST	Gets list of roles.
GetSettingInt	POST	Gets the value of integer setting by the key.
GetSettingString	POST	Gets the value of a string setting by the key.
GetSmartCaptureVerficationLink	POST	Gets a verification url/link for a document being processed in Capture AI
GetSystemCustomerId	GET	Get the customer Id of the currently connected system
GetTreeViewChildNodes	POST	Gets child nodes of a given tree view
GetTreeViewChildNodesAndDocuments	POST	Gets child nodes and documents of a given tree view
GetTreeViewNodeDocuments	POST	Gets document nodes of given tree view.
GetUserGroupNo	POST	Adds a domain user to Therefore™ and gets number of the user.
GetWebAPIServerVersion	POST	Gets the current version of the Web API server.
HandleESignaturePushNotification	POST	Handles the push notification from the eSignature service and forwards it to the server.
HasPermissions	POST	Checks if the currently logged on user has the specified permission(s) for the specified object.
HasRolePermission	POST	Checks if the currently logged on user has the specified role permission for the specified object.
QueryDependentFieldsDirect	POST	Search Therefore database table for content
RefreshNotificationSubscriptions	POST	Refreshes existing notification subscriptions.
RemoveNotificationSubscriptions	POST	Removes existing notification subscriptions.
RenameObject	POST	Rename an object in Therefore
SavePortalUser	POST	Saves or updates given portal user.
SetPermissions	POST	Sets permissions for the user on the specified object.
SetUserPassword	POST	Sets an (internal) users password
UpdateRoleAssignments	POST	Disables or enables inheritance and updates/deletes role assignments for users on one Therefore™ object.
UploadSessionAppendChunkRaw	POST	Uploads chunked data (in the body of the request as Content-Type: application/octet-stream) for the file associated with the given upload session. Accepts following mandatory HTTP headers: X-The-UploadSession-ChunkPosition, X-The-UploadSession-Id.
UploadSessionStart	POST	Starts a chunk upload session for a single file to create and archive a new Therefore™ document.

Reporting operations
ExecuteReport	POST	Executes a report with given parameters.
GetReportDefinition	POST	Gets the report definition by report definition number.

Searching operations
ExecuteAsyncFullTextQuery	POST	Starts "asynchronous" full text query. See also operations GetNextFullTextQueryRows and ReleaseFullTextQuery.
ExecuteAsyncMultiQuery	POST	Starts 'asynchronous' multi query. See also: operations GetNextMultiQueryRows and ReleaseMultiQuery. Multi query is used for searching and finding information across multiple categories with potentially different field selections, orders and conditions. FullText search string is one for all queries.
ExecuteAsyncSingleQuery	POST	Starts the 'asynchronous' single query. See also operations GetNextSingleQueryRows and ReleaseSingleQuery.
ExecuteDependentFieldsQuery	POST	Executes query for dependent field. Returns values from related referenced table.
ExecuteFullTextQuery	POST	Searches the contents of Therefore™ documents in one or more categories using information gathered by the Therefore™ indexing service.
ExecuteMultiQuery	POST	Executes queries in multiple categories.
ExecuteSimpleQuery	POST	Executes simple query on the server.
ExecuteSingleQuery	POST	Executes the single query on the server. Note (!): Set the Mode property of the query (for categoryes - NormalQuery(0), for Cases - CaseQuery(5), ...).
GetNextFullTextQueryRows	POST	Gets next portion of the data of a full text query started by ExecuteAsyncFullTextQuery operation. See also: ReleaseFullTextQuery.
GetNextMultiQueryRows	POST	Gets next portion of the data of multi query started by ExecuteAsyncMultiQuery operation. See also ReleaseMultiQuery.
GetNextSingleQueryRows	POST	Gets next portion of the data of a single query started by ExecuteAsyncSingleQuery operation. See also: ReleaseSingleQuery.
GetQuerySpecification	POST	Returns query specification: list of valid operators and operands, formats for dates and numbers.
GetSavedQuery	POST	Gets saved query (search). The Query object returned in response can be used in the ExecuteSingleQuery request (as it is or with changes).
ReleaseFullTextQuery	POST	Releases a full text query when all data is taken or is no more needed. See also: ExecuteAsyncFullTextQuery and GetNextFullTextQueryRows operations.
ReleaseMultiQuery	POST	Releases multi query when all data is taken or is no more needed. See also: ExecuteAsyncMultiQuery and GetNextMultiQueryRows operations.
ReleaseSingleQuery	POST	Releases single query when all data is taken or is no more needed. See also: ExecuteAsyncSingleQuery and GetNextSingleQueryRows operations.

Task operations
CompleteTask	POST	Completes the task with the specified task ID.
DeleteTask	POST	Deletes the task with the specified task ID.
ExecuteTaskInfoQuery	POST	Executes the query.
GetTask	POST	Gets the Task details by task number.
GetTaskInfo	POST	Gets the TaskInfo details by task number.
SetTaskStatus	POST	Changes the status of the task.
StartTask	POST	DEPRECATED: use the StartTask2 method instead. Starts a new task.
StartTask2	POST	Starts a new task.
UpdateTask	POST	DEPRECATED: use the UpdateTask2 method instead. Saves changes to the Task with the specified task ID.
UpdateTask2	POST	Saves changes to the Task with the specified task ID.
UpdateTaskComment	POST	Sets the comment of the task.

User operations
ChangeUserPassword	POST	Changes password for the specified user.
CreateUser	POST	Create new user.
ExecuteUsersQuery	POST	Searches for users in Therefore™ and/or the Active Directory.
GetConnectedUser	POST	Returns information about connected user.
GetUserDetails	POST	Returns details about user or group with the specified ID.
GetUsersFromGroup	POST	Get list of users from given group.
MoveUserLicense	POST	Moves license of authenticated user from other node to current node.
ResetUserPwd	POST	Triggers the forgot password functionality.
SignOut	POST	Releases license of authenticated user on current node.
UpdateUserGroupAssignment	POST	Updates (adds/removes) assignments of the given user to the given Therefore groups.

WebClient operations
DeleteDashboard	POST	Saves or updates an Dashboard in Therefore.
DeleteUserDashboards	POST	Deletes an user specific dashboard configuration
DeleteUserFavorites	POST	Deletes an user specific dashboard configuration
ExecuteStatisticsQuery	POST	Executes a request for statistical data of the system
GetDashboard	POST	Saves or updates an Dashboard in Therefore.
GetFieldsSaveUsageOrder	POST	Gets the order of fields used by the user when saving a new document to a category or creating a new case
GetFieldsSearchUsageOrder	POST	Gets the order of fields used by the user when searching a category/case definition
GetUserDashboards	POST	Loads an user specific dashboard configuration
GetUserFavorites	POST	Loads user specific favorites
GetViewingPages	POST	Gets the number of pages in a document for viewing
GetViewingThumbnails	POST	Gets the thumbnails for specified streams of a document or for a file from the upload session
PrepareViewing	POST	Prepares viewing/conversion of a document to html5
SaveDashboard	POST	Saves or updates an Dashboard in Therefore.
SaveUserDashboards	POST	Saves or updates an user specific dashboard configuration
SaveUserFavorites	POST	Saves or updates an user specific favorites
StartViewingSession	POST	Starts a viewing session for a specified document stream or for a file from the upload session. Also creates a thumbnail if required.
StopViewingSession	POST	Stops a viewing session for a specified document stream or for a file from the upload session. This helps freeing up resources.

Workflow operations
ClaimWorkflowInstance	POST	Claims the workflow instance.
ClearWorkflowInstanceErrors	POST	Clears the errors of given workflow instances.
DelegateWorkflowInstance	POST	Delegates the workflow instance to the specified user.
DeleteWorkflowInstance	POST	Deletes the workflow instance.
DisclaimWorkflowInstance	POST	Disclaims the current workflow instance if claimed by the current user.
ExecuteWorkflowQueryForAll	POST	Executes a workflow query returning process information for all active processes.
ExecuteWorkflowQueryForProcess	POST	Executes the workflow query for given process on the server.
FinishCurrentWorkflowTask	POST	Finishes the current task, routes the workflow instance to NextTaskNo.
GetWorkflowInstance	POST	Gets the workflow instance by number.
GetWorkflowProcess	POST	Gets the workflow process by number.
GetWorkflowTaskSettings	POST	Gets list of given settings of the workflow task.
SetChecklistItemWorkflow	POST	Sets the checked status for the specified checklist item.
SetTextInfoWorkflow	POST	Sets the free text information for the workflow instance.
StartWorkflowInstance	POST	Starts a workflow instance.