|
Web API Reference |
Scroll |
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 |
||
POST |
Closes the case with given case ID. |
|
POST |
Creates a new case, defines index data for the case and returns the case number. |
|
POST |
Deletes the case with the specified case number. |
|
POST |
Gets the case with the specified case number. |
|
POST |
Gets the case definition from the server. |
|
POST |
Gets a list of document numbers contained in the case (and a specified category). |
|
POST |
Returns the history of the case. |
|
POST |
Reopens a closed case. |
|
POST |
Updates the case index data. |
|
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 |
||
POST |
Returns tree of the categories. |
|
POST |
Returns the definition of Thereforeā¢ category. |
|
Document operations |
||
POST |
Adds file streams to an existing Thereforeā¢ document. Conversion options for the documents can be specified. |
|
POST |
Checks in the updated document. |
|
POST |
Checks out the document. |
|
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). |
|
POST |
Creates and returns a new Thereforeā¢ compound file that contains a link to a Thereforeā¢ document. |
|
POST |
Deletes an existing Thereforeā¢ document with the specified document number. |
|
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. |
|
POST |
Returns file streams of existing Thereforeā¢ document and converts them into the desired format. |
|
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. |
|
POST |
Returns the Thereforeā¢ document from the server. |
|
POST |
Returns check-out status of existing Thereforeā¢ document. |
|
POST |
Returns the history of the specified Thereforeā¢ document. |
|
POST |
Returns index data of an existing Thereforeā¢ document. |
|
POST |
Returns properties of existing Thereforeā¢ document. |
|
POST |
Returns the file stream of an existing Thereforeā¢ document for any version of the document. |
|
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). |
|
POST |
Returns the file stream of an existing Thereforeā¢ document for any version of the document. |
|
POST |
Returns the thumbnail of an existing Thereforeā¢ document. |
|
POST |
Returns index data for given category (with default values, filled dependent fields, or with ix data for autoappend, and updated calculated fields). |
|
POST |
Returns index data for given table row (with default values, filled dependent fields). |
|
POST |
Updates index data of an existing Thereforeā¢ document. |
|
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. |
|
POST |
Starts a batch operation to create and archive a new Thereforeā¢ document. |
|
POST |
Starts a batch operation to update a Thereforeā¢ document. |
|
POST |
Submits an operation to create and archive a new Thereforeā¢ document. |
|
POST |
Submits an operation to update a Thereforeā¢ document. |
|
POST |
Tests if check out is possible for given document. |
|
POST |
Frees the locked document so that other users may check it out. All changes are lost. |
|
POST |
Updates an existing Thereforeā¢ document. |
|
POST |
Uploads a file for a given batch operation. |
|
POST |
|
|
EForms operations |
||
POST |
Copies an eForm and all related child objects |
|
POST |
Saves or updates an EForm in Therefore. |
|
POST |
Delete an eForm draft in Therefore |
|
POST |
Loads an EForm from Therefore |
|
POST |
Gets an anonymous access token to fill out an eForm |
|
GET |
Get a previously saved eForm attachment file for viewing Tenant name Field Id |
|
POST |
Saves or updates an EForm in Therefore. |
|
POST |
Save default submission data for an eForm |
|
POST |
Save an eForm draft to Therefore |
|
POST |
Search saved eForm submissions for current user |
|
POST |
Loads an EForm from Therefore |
|
POST |
Upload a file to be saved as attachment to an eForm. HTTP header param: x-the-name. |
|
POST |
Returns information about connected user. |
|
Folder operations |
||
POST |
Delete a folder from Therefore |
|
POST |
Load information about a folder |
|
POST |
Save a new folder to Therefore |
|
POST |
Move a folder to another parent folder |
|
Keyword operations |
||
POST |
Adds a new keyword to the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo. |
|
POST |
Deletes the keyword from the keyword dictionary. A keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo. |
|
POST |
Gets detailed information for the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo. |
|
POST |
Gets a list of keywords for the index data of the specified field. |
|
POST |
Gets a list of keywords for the keyword dictionary of the specified field. |
|
POST |
Updates the keyword name and/or activated status in the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo. |
|
POST |
Validates keywords for a specified index data field. |
|
Link operations |
||
POST |
Gets a list of the objects linked to a given object. |
|
POST |
Gets list of workflow for given document. |
|
POST |
Creates the link between two cases. |
|
POST |
Creates the link between the document and the workflow instance. |
|
POST |
Creates the link between two documents. |
|
POST |
Removes the link between two cases. |
|
POST |
Removes the document link to a Thereforeā¢ document from the workflow instance. |
|
POST |
Removes the link between two documents. |
|
Other operations |
||
POST |
Clear local WebAPI cache |
|
POST |
Deletes given portal user. |
|
POST |
Erases deleted documents and cases from the system. |
|
POST |
Erases specified objects from the system. |
|
POST |
Executes the query returning deleted Thereforeā¢ documents and cases. |
|
POST |
Gets a list of tree view items for specific permissions. |
|
POST |
Loads discovery/connection information/settings from server |
|
POST |
Returns connection token for provided user credentials. |
|
POST |
Returns connection token for provided ADFS token. |
|
POST |
Gets the name of the default domain and a list of all valid domain names from the server. |
|
POST |
Returns JSON Web Token (JWT) for provided user credentials. |
|
POST |
Gets the permissions of a specified object. Please see also operation GetPermissionConstants. |
|
POST |
Gets a list of a specified object from the server. |
|
POST |
DEPRECATED: Use the GetRolePermissionConstants method instead. Gets a list of permission constants defined on the server. |
|
POST |
DEPRECATED: Use the GetRolePermissions method instead. Gets the permission list directly set for the user on the specified object. |
|
POST |
Gets the value of a integer public setting by the key. |
|
POST |
Gets the value of a string public setting by the key. |
|
POST |
Get technical information about the table to query in Therefore |
|
POST |
Gets list of assignments of roles to users on one Thereforeā¢ object. |
|
POST |
Gets a list of role-based permission constants defined on the server. |
|
POST |
Gets the role-based permissions set for the the connected user on the specified object. See also: operation GetRolePermissionConstants. |
|
POST |
Gets list of roles. |
|
POST |
Gets the value of integer setting by the key. |
|
POST |
Gets the value of a string setting by the key. |
|
POST |
Gets a verification url/link for a document being processed in Capture AI |
|
GET |
Get the customer Id of the currently connected system |
|
POST |
Gets child nodes of a given tree view |
|
POST |
Gets child nodes and documents of a given tree view |
|
POST |
Gets document nodes of given tree view. |
|
POST |
Gets the current version of the Web API server. |
|
POST |
Handles the push notification from the eSignature service and forwards it to the server. |
|
POST |
Checks if the currently logged on user has the specified permission(s) for the specified object. |
|
POST |
Checks if the currently logged on user has the specified role permission for the specified object. |
|
POST |
Search Therefore database table for content |
|
POST |
Rename an object in Therefore |
|
POST |
Saves or updates given portal user. |
|
POST |
Sets an (internal) users password |
|
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. |
|
POST |
Starts a chunk upload session for a single file to create and archive a new Thereforeā¢ document. |
|
Reporting operations |
||
POST |
Executes a report with given parameters. |
|
POST |
Gets the report definition by report definition number. |
|
Searching operations |
||
POST |
Starts "asynchronous" full text query. See also operations GetNextFullTextQueryRows and ReleaseFullTextQuery. |
|
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. |
|
POST |
Starts the 'asynchronous' single query. See also operations GetNextSingleQueryRows and ReleaseSingleQuery. |
|
POST |
Executes query for dependent field. Returns values from related referenced table. |
|
POST |
Searches the contents of Thereforeā¢ documents in one or more categories using information gathered by the Thereforeā¢ indexing service. |
|
POST |
Executes queries in multiple categories. |
|
POST |
Executes simple query on the server. |
|
POST |
Executes the single query on the server. Note (!): Set the Mode property of the query (for categoryes - NormalQuery(0), for Cases - CaseQuery(5), ...). |
|
POST |
Gets next portion of the data of a full text query started by ExecuteAsyncFullTextQuery operation. See also: ReleaseFullTextQuery. |
|
POST |
Gets next portion of the data of multi query started by ExecuteAsyncMultiQuery operation. See also ReleaseMultiQuery. |
|
POST |
Gets next portion of the data of a single query started by ExecuteAsyncSingleQuery operation. See also: ReleaseSingleQuery. |
|
POST |
Returns query specification: list of valid operators and operands, formats for dates and numbers. |
|
POST |
Gets saved query (search). The Query object returned in response can be used in the ExecuteSingleQuery request (as it is or with changes). |
|
POST |
Releases a full text query when all data is taken or is no more needed. See also: ExecuteAsyncFullTextQuery and GetNextFullTextQueryRows operations. |
|
POST |
Releases multi query when all data is taken or is no more needed. See also: ExecuteAsyncMultiQuery and GetNextMultiQueryRows operations. |
|
POST |
Releases single query when all data is taken or is no more needed. See also: ExecuteAsyncSingleQuery and GetNextSingleQueryRows operations. |
|
Task operations |
||
POST |
Completes the task with the specified task ID. |
|
POST |
Deletes the task with the specified task ID. |
|
POST |
Executes the query. |
|
POST |
Gets the Task details by task number. |
|
POST |
Gets the TaskInfo details by task number. |
|
POST |
Changes the status of the task. |
|
POST |
DEPRECATED: use the StartTask2 method instead. Starts a new task. |
|
POST |
Starts a new task. |
|
POST |
DEPRECATED: use the UpdateTask2 method instead. Saves changes to the Task with the specified task ID. |
|
POST |
Saves changes to the Task with the specified task ID. |
|
POST |
Sets the comment of the task. |
|
User operations |
||
POST |
Searches for users in Thereforeā¢ and/or the Active Directory. |
|
POST |
Returns information about connected user. |
|
POST |
Returns details about user or group with the specified ID. |
|
POST |
Moves license of authenticated user from other node to current node. |
|
POST |
Resets the password of a user and informs the user per email |
|
POST |
Releases license of authenticated user on current node. |
|
WebClient operations |
||
POST |
Saves or updates an Dashboard in Therefore. |
|
POST |
Deletes an user specific dashboard configuration |
|
POST |
Deletes an user specific dashboard configuration |
|
POST |
Executes a request for statistical data of the system |
|
POST |
Saves or updates an Dashboard in Therefore. |
|
POST |
Gets the order of fields used by the user when saving a new document to a category or creating a new case |
|
POST |
Gets the order of fields used by the user when searching a category/case definition |
|
POST |
Loads an user specific dashboard configuration |
|
POST |
Loads user specific favorites |
|
POST |
Gets the number of pages in a document for viewing |
|
POST |
Gets the thumbnails for specified streams of a document or for a file from the upload session |
|
POST |
Prepares viewing/conversion of a document to html5 |
|
POST |
Saves or updates an Dashboard in Therefore. |
|
POST |
Saves or updates an user specific dashboard configuration |
|
POST |
Saves or updates an user specific favorites |
|
POST |
Starts a viewing session for a specified document stream or for a file from the upload session. Also creates a thumbnail if required. |
|
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 |
||
POST |
Claims the workflow instance. |
|
POST |
Clears the errors of given workflow instances. |
|
POST |
Delegates the workflow instance to the specified user. |
|
POST |
Deletes the workflow instance. |
|
POST |
Disclaims the current workflow instance if claimed by the current user. |
|
POST |
Executes a workflow query returning process information for all active processes. |
|
POST |
Executes the workflow query for given process on the server. |
|
POST |
Finishes the current task, routes the workflow instance to NextTaskNo. |
|
POST |
Gets the workflow instance by number. |
|
POST |
Gets the workflow process by number. |
|
POST |
Gets list of given settings of the workflow task. |
|
POST |
Sets the checked status for the specified checklist item. |
|
POST |
Sets the free text information for the workflow instance. |
|
POST |
Starts a workflow instance. |
|
