Annotation
Annotation endpoint to get text or stamp annotations for documents. You can also post new annotations to this endpoint.
| Method | API | Description |
|---|---|---|
| api/Annotation/{archiveguid}/{docid} |
Get the annotations for the selected document. |
|
| api/Annotation/Comment |
Add a new annotation comment to the document. |
Archive
Endpoint for querying the archives or archivefields.
| Method | API | Description |
|---|---|---|
| api/Archive |
Retrieves a list of archives for the authenticated user. |
|
| api/Archive/{archiveguid} |
Retrieves an archive based on the provided archive GUID. |
|
| api/Archive/Version |
Retrieves the version of the application. |
|
| api/Archive/Cache |
Retrieves cached archives for the authenticated user. |
|
| api/Archive/Cache |
Removes cached archives by invalidating the cache. |
Auth
Authentication endpoint for users and externals clients
| Method | API | Description |
|---|---|---|
| api/Auth/User |
Authenticates a user based on the provided HTTP Basic Authorization header and returns a user token if authentication is successful. |
|
| api/Auth/User |
Authenticates a user based on the provided login credentials and returns an authentication token if successful. |
|
| api/Auth/App |
Authenticates an external application using the provided authorization header. |
|
| api/Auth/App |
Authenticates an external application using credentials provided in the request body and returns an authentication token if successful. |
|
| api/Auth/LongLivedToken |
Generates a long-lived token for a user based on the provided credentials and validity duration. |
Dialog
Dialogcontroller
| Method | API | Description |
|---|---|---|
| api/Dialog |
Get all dialogs for the user. |
|
| api/Dialog/Type/{type} |
Get all user dialogs for the specific type (search, result, add, index). |
|
| api/Dialog/{guid} |
Get the specific dialog by dialog Guid. |
Document
Documentcontroller
| Method | API | Description |
|---|---|---|
| api/v2/Document/{archiveguid}/{docguid} |
Get a document with all indexdata and all attached files. |
|
| api/Document/{archiveguid}/{docid} |
Get a document with all indexdata and all attached files. |
|
| api/Document/Download/{archiveguid}/{docid} |
Download a documents binary as stream. |
|
| api/Document/Link/{archiveguid}/{docid} |
Get a unique key to download the document with webbrowser. |
|
| api/Document/Log/{archiveguid}/{docid} |
Returns the protocol for the document. |
|
| api/Document/Ocr/{archiveguid}/{docid}?fileid={fileid}&pageindex={pageindex}&limit={limit} |
Retrieves the full text of a document using OCR (Optical Character Recognition). |
|
| api/Document/Preview/{archiveguid}/{docid} |
Get the preview image for the document if exists. |
|
| api/Document/Thumb/{archiveguid}/{docid} |
Get the thumbnail for the document. |
|
| api/Document |
Add a new document to topfact Archiv. |
|
| api/Document/Create |
Create a new document in topfact Archiv without files. Files must added after the request is complete. Use AddFile to add file to the document. |
|
| api/Document/Merge |
Merge multiple archive files from docid into a existing document. |
|
| api/Document/Link |
Creates a document link with a validity period and a unique key to download the document with webbrowser. |
|
| api/Document/Export |
Export a document |
|
| api/Document/FieldValues |
Returns all unique values for a archive field |
|
| api/Document |
Changes the indexdata for a document |
|
| api/Document/Lock |
Lock or unlock the requested document. |
|
| api/Document/{archiveguid}/{docid} |
Delete the document, files and all other status informations from archive. |
|
| api/Document/Image/{archiveguid}/{docid} |
Delete the image status for the requested document. |
|
| api/Document/OCR/{archiveguid}/{docid} |
Delete the ocr status for the requested document. |
File
Filecontroller
| Method | API | Description |
|---|---|---|
| api/File/{archiveguid}/{docid} |
Get all files for the document (include filecontent). |
|
| api/File/{archiveguid}/{docid}/{fileid} |
Get the specific file for the document (inculde filecontent). |
|
| api/File/Info/{archiveguid}/{docid} |
Return all files to the document without file binaries. |
|
| api/File/Ocr/{archiveguid}/{docid}/{fileid}?pageindex={pageindex}&limit={limit} |
Return the fulltext of the file. |
|
| api/File/Stream/{archiveguid}/{docid}/{fileid} |
Download only the file binary as stream. Use parameter format with original or pdf. |
|
| api/File/Stream |
Retrieves a file as a stream based on the provided request parameters. This method is invoked via an HTTP POST request to the specified route. |
|
| api/File |
Add a new file to an existing stored document. |
|
| api/File/{archiveguid}/{docid}?filename={filename} |
Add a new file to an existing stored document as stream. This is for large files. |
|
| api/File |
Update file position and visibility |
|
| api/File/Version |
Move the file to the history and create a new file version. |
|
| api/File/Rename |
Renames a file based on the provided request data. |
|
| api/File/{archiveguid}/{docid}/{fileid} |
Delete additional files attached to a document, the main file cannot deleted |
Info
| Method | API | Description |
|---|---|---|
| api/Info/Version |
Retrieves the version of the application. |
List
| Method | API | Description |
|---|---|---|
| api/List/Dynamic |
Get all mobile lists for the current user. |
|
| api/List/Simple |
OCR
Provides an API for Optical Character Recognition (OCR) functionalities.
| Method | API | Description |
|---|---|---|
| api/OCR/Status |
Retrieves the count of unprocessed files. |
|
| api/OCR/File |
Retrieves an unprocessed file for OCR processing. |
|
| api/OCR/File |
Adds a file to the OCR (Optical Character Recognition) processing queue. |
|
| api/OCR/File/Result |
Handles the OCR file result submission. |
Search
Provides functionality to search for resources. The following Endpoints are Obselete: api/Document/Search, api/Document/SearchIDs, api/Document/SearchProfessional
| Method | API | Description |
|---|---|---|
| api/Search?archiveguid={archiveguid}&search={search}&columns={columns}&count={count}&countOnly={countOnly} |
Searches for documents in the specified archive using the provided search criteria and returns the matching results or the count of matching documents. |
|
| api/Search |
Searches for documents based on the provided search request. |
|
| api/Document/Search |
Searches for documents based on the provided search request. |
|
| api/Search/DocIDs |
Searches for documents by their IDs based on the provided search request. |
|
| api/Document/SearchIDs |
Searches for documents by their IDs based on the provided search request. |
|
| api/Search/Professional |
Searches for professional documents based on the provided search request. |
|
| api/Document/SearchProfessional |
Searches for professional documents based on the provided search request. |
Stamp
Controller to get stamps for the entire archives, for the current user or stamps assigned to a structure.
| Method | API | Description |
|---|---|---|
| api/Stamp/Archive/{archiveguid} |
Get all stamps for the selected archive. |
|
| api/Stamp/Groups/{archiveguid} |
Get the users stamps in the selected archive, assigned to his groups. |
|
| api/Stamp/Structure/{strukturId} |
User
Provides API endpoints for user-related operations.
| Method | API | Description |
|---|---|---|
| api/User/Login |
Obsolete, Authenticates a user based on the provided HTTP Basic Authorization header. |
|
| api/User |
Retrieves the user information based on the provided access key. |
|
| api/User/License |
Retrieves the user licenses for the authenticated user. |
|
| api/User/Profiles/{archiveGuid} |
Retrieves user profiles based on the provided archive GUID. |
|
| api/User/Logout |
Logs out a user from the system. |