Articles in this section

Available Laserfiche APIs

When you configure an export, import, other type of flow step using the prebuilt Laserfiche connector, you can select any of the API operations listed below, organized by API type.

Note: If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Laserfiche API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Attributes Return an attribute object associated with the authenticated user X  
Return the attribute key value pairs associated with the authenticated user X  
Audit reasons Return the audit reasons associated with the authenticated user X  
Collection Create a new smart collection   X
Delete an existing smart collection   X
Get metadata and statistics about a specific collection X  
Query a collection using a natural language prompt X  
Documents Delete documents from the collection   X
Insert documents or text content into a collection   X
Entries Assign a template to an entry   X
Assign links to an entry   X
Assign tags to an entry   X
Check in a document, creating a new version   X
Check out a document   X
Copy a new child entry in a folder   X
Copy pages from the source document to a destination document   X
Create a new child entry in a folder   X
Create a persistent lock on a document   X
Create new pages in a document   X
Delete the eDoc associated with an entry   X
Delete the pages associated with an entry   X
Export an entry X  
Get the persistent lock state of a document X  
Move pages within a document to a new position   X
Put a document under version control   X
Remove a persistent lock from a document   X
Remove the currently assigned template from an entry   X
Replace all pages on the document with new pages from the provided image files and/or text content   X
Request upload URLs to upload a large file in chunks   X
Return a single entry object X  
Return a single entry object using the entry path X  
Return page information for the pages of a document X  
Return the children entries of a folder X  
Return the dynamic field logic values assigned to an entry X  
Return the fields assigned to an entry X  
Return the image content of a specific page in a document X  
Return the links assigned to an entry X  
Return the tags assigned to an entry X  
Return the text content of a specific page in a document X  
Rotate an image page in the document   X
Start an asynchronous copy task to copy an entry into a folder   X
Start an asynchronous delete task to delete an entry   X
Start an asynchronous export task to export an entry X  
Start an asynchronous import task to import a document into a folder   X
Trigger server-side text generation for a document   X
Undo a document check-out without creating a new version   X
Update an entry   X
Update a document entry's electronic document and/or metadata from previously uploaded parts   X
Update a document entry's electronic document, image pages, and/or metadata   X
Update the field values assigned to an entry   X
Write the image and/or text content of an existing page in the document   X
Field definitions Change the data type of an existing field definition   X
Create a new field definition in the repository   X
Delete a field definition from the repository   X
Get the custom-properties bag for a field definition X  
Merge two or more field definitions into a new field definition   X
Partially updates the custom-properties bag for a field definition   X
Replace the list values for a list-backed field definition   X
Return a single field definition object X  
Return the count of entries that have a value assigned for the specified field definition X  
Return the list values configured on a list-backed field definition X  
Return the paged listing of the field definitions available in a repository X  
Return the templates that contain the specified field definition X  
Update properties of an existing field definition (partial update)   X
Link definitions Return a single link definition object X  
Return the link definitions associated with a repository X  
Repositories Return the list of repositories accessible to the user X  
Searches Return the context hits associated with a search result entry X  
Return the results listing associated with a search task X  
Start an asynchronous search task X  
Secure metadata Get general metadata X  
Get general OData service document X  
Get table metadata X  
Get table OData service document X  
Service Get the total storage usage (in bytes) for all smart collections X  
Simple searches Run a simple search X  
Table Add a row to a table   X
Delete a table row by key   X
Get table row by key X  
Get table rows X  
Upsert or update a table row by key   X
Tag definitions Return a single tag definition object X  
Return the tag definitions associated with a repository X  
Task Cancel task   X
Get task X  
Tasks Return the status of a set of one or more tasks X  
Start a test operation that behaves according to specified parameters   X
Start the cancellation for a set of one or more tasks   X
Template definitions Add a field to a template   X
Create a new template definition in the repository   X
Delete a template definition from the repository   X
Get the custom-properties bag for a template definition X  
Move a field to a new position within a template   X
Partially updates the custom-properties bag for a template definition   X
Remove a field from a template   X
Return a single template definition object X  
Return the count of entries currently assigned to the specified template definition X  
Return the field definitions assigned to a template definition (by template definition ID) X  
Return the field definitions assigned to a template definition (by template definition name) X  
Return the template definitions associated with a repository X  
Update per-template properties for a field assignment on a template   X
Update properties of an existing template definition (partial update)   X