Laserfiche
App · 25 actions
Work with documents in Laserfiche Cloud: import files and text, find them by search, read and set templates, field values, tags and links, move, copy, rename, export and delete them, and start workflows when documents arrive or change.
Actions
| Action | What it does |
|---|---|
| Add link | Link an entry to another, such as an application to its supporting documents. |
| Add tags | Add tags to an entry. |
| Copy entry | Copy a document or folder (with everything in it) into a folder. |
| Create folder | Create a folder. |
| Delete entry | Delete a document, or a folder with everything in it. |
| Export document | Download a document's original file, its pages (as a PDF or images) or its text, as a file for later steps. |
| Get entry | Get a document or folder by its entry ID or path: its name, path, template, dates and, for a document, its file type and page count. |
| Get entry tags | Get the tags an entry has. |
| Get field values | Get an entry's field values, as a list and by field name. |
| Get links | Get the links between an entry and other entries. |
| Import document | Save a file (or text) as a new document in a folder, with a template, field values and tags if given. |
| List folder contents | List the documents and folders in a folder, a page at a time, optionally with chosen field values. |
| List link types | List the kinds of link the repository has, such as Application / Supporting document. |
| List repositories | List the Laserfiche repositories the connection can reach, with their IDs. |
| List tags | List the tags the repository has. |
| List template fields | List a template's fields: their names, types, choices and rules. |
| List templates | List the repository's templates. |
| Move entry | Move a document or folder into another folder. |
| Remove link | Remove one of an entry's links. |
| Remove tags | Take tags off an entry. |
| Remove template | Take the template off an entry, with its template fields. |
| Rename entry | Give a document or folder a new name. |
| Search | Find documents and folders by words, name, type, folder, template, tag, a field's value or dates. |
| Set template | Give an entry a template, replacing the one it had, and fill in its fields. |
| Update field values | Change some of an entry's field values. |
Add link
Link an entry to another, such as an application to its supporting documents. Its other links are kept.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Link type
link_typetextRequired - The kind of link, as set up in your repository.
- Other entry
other_entrytextRequired - The entry to link to: its entry ID or full path.
- Entry is the first side
entry_is_sourcetrue/false - On: 'Entry' is the link's first (source) side and 'Other entry' the second. Off: the other way round.Default:
true.
Outputs
countnumber- How many
entry_idnumber- The entry's ID
linkslist- The entry's links
Example output
{
"count": 1,
"entry_id": 20393,
"links": [
{
"customProperties": {},
"description": "Supporting document",
"id": 77,
"linkDefinitionDescription": "Application and its supporting documents",
"linkDefinitionId": 2,
"sourceFullPath": "\\Permits\\2026\\Building permit application",
"sourceId": 20393,
"sourceLabel": "Application",
"targetFullPath": "\\Permits\\2026\\Site plan",
"targetId": 20394,
"targetLabel": "Supporting document"
}
]
}Add tags
Add tags to an entry. Tags it already has are kept.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Tags
tagslistRequired - The tags. Pick them, or type their names.
Outputs
entry_idnumber- The entry's ID
nameslist- The names of the entry's tags
tagslist- The entry's tags
Example output
{
"entry_id": 20393,
"names": [
"Needs Review"
],
"tags": [
{
"description": "Waiting for the clerk's review",
"displayName": "Needs Review",
"id": 3,
"isSecure": false,
"name": "Needs Review"
}
]
}Copy entry
Copy a document or folder (with everything in it) into a folder.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- To folder
destination_foldertextRequired - Where to copy it. Pick one, or give a folder's entry ID or full path.
- New name
nametext - A name for the copy. Leave empty to keep the original's.
- Rename if the name is taken
auto_renametrue/false - If the folder already has an entry with this name, add a number to the new one's name instead of failing.Default:
false.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20401,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}Create folder
Create a folder. A name such as Permits\2026\October creates each missing folder along the way.
Inputs
- In folder
parent_foldertextRequired - Where to create it. Pick one, or give a folder's entry ID or full path.
- Name
nametextRequired - The new folder's name, or a path of folders to create.
- Rename if the name is taken
auto_renametrue/false - If the folder already has an entry with this name, add a number to the new one's name instead of failing.Default:
false.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-01-02T09:00:00Z",
"creator": "Lodol Service",
"electronicDocumentSize": null,
"entryType": "Folder",
"extension": null,
"fields": null,
"folderPath": "\\Permits",
"fullPath": "\\Permits\\2026",
"id": 54,
"isCheckedOut": null,
"isContainer": true,
"isElectronicDocument": null,
"isLeaf": false,
"isRecord": null,
"isRecordFolder": false,
"isUnderVersionControl": null,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": null,
"name": "2026",
"pageCount": null,
"parentId": 41,
"rowNumber": null,
"targetId": null,
"templateFieldNames": null,
"templateId": 0,
"templateName": null,
"volumeName": "CLOUD"
}
}Delete entry
Delete a document, or a folder with everything in it. Laserfiche deletes in the background; the step waits up to three minutes for it to finish.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Audit reason
audit_reasontext - The reason to record for the delete, if your repository asks for one.
- Comment
commenttext - A comment to record with the delete.
Outputs
deletedtrue/false- True once the delete finished
entry_idnumber- The entry's ID
statustext- Completed, or InProgress if it is still deleting
task_idtext- Laserfiche's ID for the delete
Example output
{
"deleted": true,
"entry_id": 20393,
"status": "Completed",
"task_id": "f1201c58-0dd0-4e39-abcc-450acff1b791"
}Export document
Download a document's original file, its pages (as a PDF or images) or its text, as a file for later steps.
Inputs
- Document
entrytextRequired - The document: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- What to download
parttext - The original file, the pages, or the text. Defaults to the original file.One of:
Edoc(The original file (electronic document)),Image(The scanned pages, as images or a PDF),Text(The text of the pages). Default:Edoc. - Page format
image_formattext - The format for the pages. Defaults to PDF.Only when What to download is The scanned pages, as images or a PDF. One of:
PDF,MultiPageTIFF(TIFF, one file),SinglePageTIFF(TIFF, one file per page (zip)),PNG,JPEG. Default:PDF. - Audit reason
audit_reasontext - The reason to record for the export, if your repository asks for one.
Outputs
content_typetext- The file's type
document_reftext- The saved file, for later steps
entry_idnumber- The entry's ID
filenametext- The file's name
parttext- What was downloaded: Edoc, Image or Text
size_bytesnumber- The file's size in bytes
urltext- Where to open the saved file
Example output
{
"content_type": "application/pdf",
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"entry_id": 20393,
"filename": "Building permit application.pdf",
"part": "Edoc",
"size_bytes": 63369,
"url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef"
}Get entry
Get a document or folder by its entry ID or path: its name, path, template, dates and, for a document, its file type and page count.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}Get entry tags
Get the tags an entry has.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
Outputs
entry_idnumber- The entry's ID
nameslist- The names of the entry's tags
tagslist- The entry's tags
Example output
{
"entry_id": 20393,
"names": [
"Needs Review"
],
"tags": [
{
"description": "Waiting for the clerk's review",
"displayName": "Needs Review",
"id": 3,
"isSecure": false,
"name": "Needs Review"
}
]
}Get field values
Get an entry's field values, as a list and by field name.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
Outputs
entry_idnumber- The entry's ID
fieldslist- The entry's fields
valuesobject- Each field's value by name: text for a single value, a list for a multi-value field
Example output
{
"entry_id": 20393,
"fields": [
{
"fieldType": "String",
"groupId": null,
"hasMoreValues": false,
"id": 12,
"isMultiValue": false,
"isRequired": true,
"name": "Permit Number",
"values": [
"BP-2026-0142"
]
}
],
"values": {
"Permit Number": "BP-2026-0142"
}
}Get links
Get the links between an entry and other entries.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
Outputs
countnumber- How many
entry_idnumber- The entry's ID
linkslist- The entry's links
Example output
{
"count": 1,
"entry_id": 20393,
"links": [
{
"customProperties": {},
"description": "Supporting document",
"id": 77,
"linkDefinitionDescription": "Application and its supporting documents",
"linkDefinitionId": 2,
"sourceFullPath": "\\Permits\\2026\\Building permit application",
"sourceId": 20393,
"sourceLabel": "Application",
"targetFullPath": "\\Permits\\2026\\Site plan",
"targetId": 20394,
"targetLabel": "Supporting document"
}
]
}Import document
Save a file (or text) as a new document in a folder, with a template, field values and tags if given. Files up to 100 MB.
Inputs
- Folder
foldertextRequired - Where to save it. Pick one, or give a folder's entry ID or full path.
- Name
nametextRequired - The document's name in Laserfiche, without the extension.
- File
filetext - The file to import: upload one or pick a file from an earlier step. Leave empty to save 'Text' instead, or to make a document with no pages.
- Text
texttext - Text to save as the document (as a .txt file) when no file is given, such as an email's body.
- Template
templatetext - A template to give the document. Pick one, or type its name.
- Field values
field_valuesobject - A value for each field to fill in. Fields left empty are not changed. For a field that holds several values, give a list.
- Tags
tagslist - Tags to give the document.
- Keep as the original file
keep_originaltrue/false - Store an image or text file as the document's file. Turn off to make its pages instead. PDFs and Office files are always kept as files.Default:
true. - Make text searchable
make_searchabletrue/false - Have Laserfiche read the file's text (OCR) so search finds it.Default:
false. - Rename if the name is taken
auto_renametrue/false - If the folder already has an entry with this name, add a number to the new one's name instead of failing.Default:
false.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}List folder contents
List the documents and folders in a folder, a page at a time, optionally with chosen field values. Pass 'next_skip' as 'Skip' for the next page.
Inputs
- Folder
foldertextRequired - The folder to list. Pick one, or give a folder's entry ID or full path.
- Order
order_bytext - How to sort the entries.One of:
name asc(Name, A to Z),name desc(Name, Z to A),creationTime desc(Newest first),creationTime asc(Oldest first),lastModifiedTime desc(Recently changed first). - Field values to include
field_nameslist - Up to 10 fields whose value each entry should come back with (the first value of a multi-value field).
- Page size
limitnumber - How many entries to return, 1 to 150. Defaults to 100.From 1 to 150.
- Skip
skipnumber - How many entries to skip, such as 'next_skip' from an earlier page.At least 0.
Outputs
countnumber- How many
entrieslist- The folder's entries
folder_idnumber- The folder's entry ID
next_skipnumber- The 'Skip' for the next page, empty on the last
totalnumber- How many entries the folder has
Example output
{
"count": 1,
"entries": [
{
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
],
"folder_id": 54,
"next_skip": null,
"total": 1
}List link types
List the kinds of link the repository has, such as Application / Supporting document.
Inputs
None.
Outputs
countnumber- How many
link_typeslist- The link types
Example output
{
"count": 1,
"link_types": [
{
"description": "Application and its supporting documents",
"id": 2,
"sourceLabel": "Application",
"targetLabel": "Supporting document"
}
]
}List repositories
List the Laserfiche repositories the connection can reach, with their IDs.
Inputs
None.
Outputs
countnumber- How many
repositorieslist- The repositories
Example output
{
"count": 1,
"repositories": [
{
"id": "r-abc123",
"name": "City Clerk",
"webClientUrl": "https://app.laserfiche.com/laserfiche"
}
]
}List tags
List the tags the repository has.
Inputs
None.
Outputs
countnumber- How many
tagslist- The tags
Example output
{
"count": 1,
"tags": [
{
"description": "Waiting for the clerk's review",
"displayName": "Needs Review",
"id": 3,
"isSecure": false,
"name": "Needs Review"
}
]
}List template fields
List a template's fields: their names, types, choices and rules.
Inputs
- Template
templatetextRequired - The template. Pick one, or type its name.
Outputs
countnumber- How many
fieldslist- The template's fields
templatetext- The template's name
Example output
{
"count": 1,
"fields": [
{
"constraint": null,
"constraintError": null,
"defaultValue": null,
"description": "The number the permit desk gives",
"displayName": "Permit Number",
"fieldType": "String",
"format": "None",
"id": 12,
"isMultiValue": false,
"isRequired": true,
"length": 40,
"listValues": [],
"name": "Permit Number"
}
],
"template": "Permit Application"
}List templates
List the repository's templates.
Inputs
None.
Outputs
countnumber- How many
templateslist- The templates
Example output
{
"count": 1,
"templates": [
{
"description": "Building and land use permit applications",
"displayName": "Permit Application",
"fieldCount": 3,
"id": 9865,
"isAutoAssignable": false,
"name": "Permit Application"
}
]
}Move entry
Move a document or folder into another folder.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- To folder
destination_foldertextRequired - Where to move it. Pick one, or give a folder's entry ID or full path.
- Rename if the name is taken
auto_renametrue/false - If the folder already has an entry with this name, add a number to the new one's name instead of failing.Default:
false.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 60,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}Remove link
Remove one of an entry's links. Its other links are kept.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Link ID
link_idtextRequired - The link's ID, from 'Get links' or 'Add link'.
Outputs
countnumber- How many
entry_idnumber- The entry's ID
linkslist- The entry's links
Example output
{
"count": 0,
"entry_id": 20393,
"links": []
}Remove tags
Take tags off an entry. Its other tags are kept.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Tags
tagslistRequired - The tags. Pick them, or type their names.
Outputs
entry_idnumber- The entry's ID
nameslist- The names of the entry's tags
tagslist- The entry's tags
Example output
{
"entry_id": 20393,
"names": [],
"tags": []
}Remove template
Take the template off an entry, with its template fields.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 0,
"templateName": null,
"volumeName": "CLOUD"
}
}Rename entry
Give a document or folder a new name.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- New name
nametextRequired - The new name.
- Rename if the name is taken
auto_renametrue/false - If the folder already has an entry with this name, add a number to the new one's name instead of failing.Default:
false.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit BP-2026-0142",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}Search
Find documents and folders by words, name, type, folder, template, tag, a field's value or dates. Returns up to 100 matches.
Inputs
- Words
texttext - Words to find in names, the text of documents, field values and annotations.
- Name
nametext - The entry's name. Use * for any characters, as in *invoice*.
- Type
entry_typetext - Only documents, only folders, or both. Leave empty for any.One of:
D(Documents),F(Folders),DF(Documents and folders). - In folder
foldertext - Only entries in this folder. Pick one, or give a folder's entry ID or full path.
- Include subfolders
include_subfolderstrue/false - Also search the folders inside it. On unless turned off.Default:
true. - Template
templatetext - Only entries with this template.
- Tag
tagtext - Only entries with this tag.
- Field
field_nametext - Only entries whose value in this field matches 'Field value'.
- Field value
field_valuetext - The value 'Field' must have. Use * for any characters.
- Created on or after
created_afterdate - Only entries created on or after this date.
- Created on or before
created_beforedate - Only entries created on or before this date.
- Changed on or after
modified_afterdate - Only entries changed on or after this date.
- Laserfiche search syntax
search_syntaxtext - For anything the other fields don't cover: a search written in Laserfiche's search syntax, such as {LF:Ext="pdf"}. Combined with the other fields.
- Field values to include
field_nameslist - Up to 10 fields whose value each entry should come back with (the first value of a multi-value field).
- Order
order_bytext - How to sort the entries.One of:
name asc(Name, A to Z),name desc(Name, Z to A),creationTime desc(Newest first),creationTime asc(Oldest first),lastModifiedTime desc(Recently changed first).
Outputs
countnumber- How many
entrieslist- The entries found
search_commandtext- The search, in Laserfiche's search syntax
truncatedtrue/false- True when there were more than 100 matches
Example output
{
"count": 1,
"entries": [
{
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
],
"search_command": "{[Permit Application]} & {LF:Name=\"*\", Type=D}",
"truncated": false
}Set template
Give an entry a template, replacing the one it had, and fill in its fields.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Template
templatetextRequired - The template. Pick one, or type its name.
- Field values
field_valuesobject - A value for each field to fill in. Fields left empty are not changed. For a field that holds several values, give a list.
Outputs
entryobject- The entry
Example output
{
"entry": {
"creationTime": "2026-10-30T14:52:18Z",
"creator": "Lodol Service",
"electronicDocumentSize": 63369,
"entryType": "Document",
"extension": "pdf",
"fields": null,
"folderPath": "\\Permits\\2026",
"fullPath": "\\Permits\\2026\\Building permit application",
"id": 20393,
"isCheckedOut": false,
"isContainer": false,
"isElectronicDocument": true,
"isLeaf": true,
"isRecord": false,
"isRecordFolder": null,
"isUnderVersionControl": false,
"lastModifiedTime": "2026-10-30T14:52:23Z",
"mimeType": "application/pdf",
"name": "Building permit application",
"pageCount": 7,
"parentId": 54,
"rowNumber": null,
"targetId": null,
"templateFieldNames": [
"Permit Number",
"Applicant",
"Received"
],
"templateId": 9865,
"templateName": "Permit Application",
"volumeName": "CLOUD"
}
}Update field values
Change some of an entry's field values. Only the fields given change; the rest keep their values.
Inputs
- Entry
entrytextRequired - The document or folder: its entry ID (a number, usually from an earlier step) or its full path, such as \Permits\2026\Application.
- Template
templatetextRequired - The entry's template, whose fields are listed to fill in.
- Field values
field_valuesobjectRequired - A value for each field to change. Fields left empty keep their values. For a field that holds several values, give a list.
Outputs
entry_idnumber- The entry's ID
fieldslist- The entry's fields
valuesobject- Each field's value by name: text for a single value, a list for a multi-value field
Example output
{
"entry_id": 20393,
"fields": [
{
"fieldType": "String",
"groupId": null,
"hasMoreValues": false,
"id": 12,
"isMultiValue": false,
"isRequired": true,
"name": "Permit Number",
"values": [
"BP-2026-0142"
]
}
],
"values": {
"Permit Number": "BP-2026-0142"
}
}