Hyland OnBase
App · 9 actions
Store documents in OnBase with their keywords, search a document type by keyword values and dates, read and change a document's keywords, download its file, and start workflows when a document arrives or gets a keyword value.
Actions
| Action | What it does |
|---|---|
| Download document | Get the file of a document's latest revision, for later steps to attach, read or send. |
| Find keyword types | Look up keyword types by their names or ids. |
| Get document | Get a document's name, document type, dates and status. |
| Get document keywords | Get a document's keyword values, by keyword type. |
| Get document type keywords | List the keyword types a document type takes, with the values a new document gets by default. |
| List document types | List the document types the OnBase user can see, with their ids. |
| Search documents | Find documents of a document type whose keywords match, and whose document date falls in a range. |
| Update document keywords | Set some of a document's keyword values, keeping the others as they are. |
| Upload document | Store a new document in OnBase under a document type, with its keyword values. |
Download document
Get the file of a document's latest revision, for later steps to attach, read or send.
Inputs
- Document ID
document_idtextRequired - The document's id (its document handle), from 'Search documents', a trigger or an earlier step.
Outputs
content_typetext- The file's type, such as application/pdf
document_idtext- The document
document_reftext- The file, for later steps to use
file_nametext- The file's name
sizenumber- The file's size in bytes
Example output
{
"content_type": "application/pdf",
"document_id": "101452",
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"file_name": "BP-2026-0142.pdf",
"size": 48213
}Find keyword types
Look up keyword types by their names or ids.
Inputs
- Names
nameslist - Keyword type names to look up, such as Permit Number.
- IDs
idslist - Keyword type ids to look up.
Outputs
countnumber- How many were found
keyword_typeslist- The keyword types found
Example output
{
"count": 1,
"keyword_types": [
{
"id": "201",
"name": "Permit Number"
}
]
}Get document
Get a document's name, document type, dates and status.
Inputs
- Document ID
document_idtextRequired - The document's id (its document handle), from 'Search documents', a trigger or an earlier step.
Outputs
documentobject- An OnBase document
Example output
{
"document": {
"createdByUserId": "312",
"documentDate": "2026-10-28",
"id": "101452",
"name": "Building Permit BP-2026-0142",
"status": "Active",
"storedDate": "2026-10-28T15:04:11Z",
"typeId": "143"
}
}Get document keywords
Get a document's keyword values, by keyword type.
Inputs
- Document ID
document_idtextRequired - The document's id (its document handle), from 'Search documents', a trigger or an earlier step.
Outputs
countnumber- How many keyword types have values
document_idtext- The document
keywordslist- Its keyword values
values_by_nameobject- Each keyword type's values by its name, such as {"Permit Number": ["BP-2026-0142"]}
Example output
{
"count": 2,
"document_id": "101452",
"keywords": [
{
"formatted_values": [
"BP-2026-0142"
],
"keyword_type_id": "201",
"name": "Permit Number",
"values": [
"BP-2026-0142"
]
},
{
"formatted_values": [
"Approved"
],
"keyword_type_id": "202",
"name": "Status",
"values": [
"Approved"
]
}
],
"values_by_name": {
"Permit Number": [
"BP-2026-0142"
],
"Status": [
"Approved"
]
}
}Get document type keywords
List the keyword types a document type takes, with the values a new document gets by default.
Inputs
- Document type
document_type_idtextRequired - The OnBase document type. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many there are
document_type_idtext- The document type
keyword_guidtext- OnBase's guard for the keyword collection
keyword_typeslist- The keyword types it takes
Example output
{
"count": 2,
"document_type_id": "143",
"keyword_guid": "a1b2c3d4",
"keyword_types": [
{
"default_values": [],
"id": "201",
"name": "Permit Number"
},
{
"default_values": [
"Pending"
],
"id": "202",
"name": "Status"
}
]
}List document types
List the document types the OnBase user can see, with their ids.
Inputs
- Name contains
name_containstext - Only document types whose name contains this text.
- Exact name
nametext - Only the document type with exactly this name.
Outputs
countnumber- How many there are
document_typeslist- The document types
Example output
{
"count": 1,
"document_types": [
{
"documentTypeGroupId": "12",
"id": "143",
"name": "Building Permit"
}
]
}Search documents
Find documents of a document type whose keywords match, and whose document date falls in a range.
Inputs
- Document type
document_type_idtextRequired - The OnBase document type. Pick one, or give its id from an earlier step.
- Keywords
keywordsobject - Keyword values a document must have, all of them.
- Document date from
from_datedate - Only documents dated on or after this day.
- Document date to
to_datedate - Only documents dated on or before this day.
- Most results
max_resultsnumber - How many documents to return at most, 1 to 1000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many matched
documentslist- The matching documents
query_idtext- OnBase's id for the search
Example output
{
"count": 1,
"documents": [
{
"createdByUserId": "312",
"documentDate": "2026-10-28",
"id": "101452",
"name": "Building Permit BP-2026-0142",
"status": "Active",
"storedDate": "2026-10-28T15:04:11Z",
"typeId": "143"
}
],
"query_id": "9f2c7a10"
}Update document keywords
Set some of a document's keyword values, keeping the others as they are. A keyword left blank is cleared.
Inputs
- Document ID
document_idtextRequired - The document's id (its document handle), from 'Search documents', a trigger or an earlier step.
- Document type
document_type_idtext - The document's document type, to list its keyword types. The step checks the document is of this type.
- Keywords
keywordsobjectRequired - The keyword values to set, by keyword type.
Outputs
countnumber- How many keyword types have values
document_idtext- The document
keywordslist- Its keyword values after the change
updated_keyword_type_idslist- The keyword types that were set
values_by_nameobject- Each keyword type's values by its name, such as {"Permit Number": ["BP-2026-0142"]}
Example output
{
"count": 2,
"document_id": "101452",
"keywords": [
{
"formatted_values": [
"BP-2026-0142"
],
"keyword_type_id": "201",
"name": "Permit Number",
"values": [
"BP-2026-0142"
]
},
{
"formatted_values": [
"Approved"
],
"keyword_type_id": "202",
"name": "Status",
"values": [
"Approved"
]
}
],
"updated_keyword_type_ids": [
"202"
],
"values_by_name": {
"Permit Number": [
"BP-2026-0142"
],
"Status": [
"Approved"
]
}
}Upload document
Store a new document in OnBase under a document type, with its keyword values. Give a file, or text to store as a text file.
Inputs
- Document type
document_type_idtextRequired - The OnBase document type. Pick one, or give its id from an earlier step.
- File
filetext - The file to store: upload one or pick one from an earlier step.
- Text
contenttext - Text to store as the document, when no file is given.
- File name
file_nametext - The file's name with its extension, such as permit.pdf. The extension is sent to OnBase with the file.
- Keywords
keywordsobject - The document's keyword values. The document type's defaults fill in the rest.
- File format ID
file_type_idtext - The OnBase file format's id. Leave empty unless your OnBase administrator says the document type needs one.
Outputs
documentobject- An OnBase document
document_idtext- The new document's id
file_nametext- The name the file was sent as
Example output
{
"document": {
"createdByUserId": "312",
"documentDate": "2026-10-28",
"id": "101452",
"name": "Building Permit BP-2026-0142",
"status": "Active",
"storedDate": "2026-10-28T15:04:11Z",
"typeId": "143"
},
"document_id": "101452",
"file_name": "permit.pdf"
}