DocuWare

App · 20 actions

Store, find, file and download documents in DocuWare with their index values, stamp them, and act on DocuWare workflow tasks.

Actions

ActionWhat it does
Add file to documentAdd a file to a document that's already stored, such as an attachment or a file for an index-only record.
Confirm taskTake a decision on a workflow task, such as Approve, filling in what the decision asks for.
Delete documentDelete a document.
Download documentDownload a document's file, as stored or as a PDF, for a later step to attach or send.
Get documentGet one document's index values, files and details, such as when it was stored and changed.
Get document's workflow historyGet the DocuWare workflows a document has been through, step by step: who decided what, and when.
Get file cabinetGet a file cabinet or document tray with its index fields: each field's database name, label and type.
Get organizationGet the DocuWare organization the connection signs in to, with its name and id.
Get taskGet one workflow task with the decisions that can be taken and what each asks for.
List dialogsList a file cabinet's dialogs (search, store, result list and so on) that the DocuWare user may use.
List documentsList the documents in a file cabinet or document tray, newest first, with their index values.
List file cabinetsList the file cabinets and document trays the DocuWare user can see, with their ids.
List my tasksList the user's workflow tasks with their decisions: in one workflow, or in every workflow that has some.
List stampsList the stamps the DocuWare user may place on a file cabinet's documents, such as Approved or Received.
List workflowsList the DocuWare workflows that have a task list for the user, with how many tasks each holds.
Place stampPlace a stamp, such as Approved, on a page of a document.
Search documentsFind documents in a file cabinet by their index values and when they were stored.
Store documentStore a file in a file cabinet or document tray with its index values.
Transfer documentMove a document from a document tray (or another file cabinet) into a file cabinet, with index values, as filing it in DocuWare does.
Update index valuesChange a stored document's index values.

Add file to document

Add a file to a document that's already stored, such as an attachment or a file for an index-only record.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.
FilefiletextRequired
The file: upload one, pick a file from an earlier step, or paste a public https link to one.

Outputs

documentobject
The document
Example output
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  }
}

Confirm task

Take a decision on a workflow task, such as Approve, filling in what the decision asks for. The workflow moves on in DocuWare.

Inputs

DocuWare workflowdocuware_workflow_idtextRequired
The DocuWare workflow. Pick one, or give its id from an earlier step.
Instance IDinstance_idtextRequired
The task's 'instance_id', from 'List tasks' or the trigger.
Task IDtask_idtextRequired
The task's 'id', from 'List tasks' or the trigger.
DecisiondecisiontextRequired
The decision as it appears on the task, such as Approve. 'Get task' lists them.
Decision fieldsform_valuesobject
What the decision asks for, by its label, such as {"Comment": "Checked against the order"}.

Outputs

confirmedtrue/false
Always true once confirmed
decisiontext
The decision taken
decision_idnumber
The decision's id
docuware_workflow_idtext
Its workflow
instance_idtext
Its workflow instance
task_idtext
The task confirmed
Example output
{
  "confirmed": true,
  "decision": "Approve",
  "decision_id": 1,
  "docuware_workflow_id": "29341189-7564-4194-ba2c-33963f41891f",
  "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
  "task_id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10"
}

Delete document

Delete a document. DocuWare keeps it in its trash bin for a while, if the organization has one.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
document_idnumber
The document deleted
file_cabinet_idtext
The file cabinet it was in
Example output
{
  "deleted": true,
  "document_id": 1234,
  "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709"
}

Download document

Download a document's file, as stored or as a PDF, for a later step to attach or send.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.
Formatfile_formattext
As stored (the default; several files come as a ZIP), as one PDF, or always as a ZIP.One of: Auto (As stored (default)), PDF, Zip (ZIP of the original files).
Include stamps and noteskeep_annotationstrue/false
Burn the document's stamps and annotations into the file.

Outputs

content_typetext
The file's type, such as application/pdf
document_idnumber
The DocuWare document downloaded
document_reftext
The downloaded file, for later steps
file_cabinet_idtext
The file cabinet it is in
filenametext
The file's name
size_bytesnumber
The file's size in bytes
urltext
Where to open the downloaded file
Example output
{
  "content_type": "application/pdf",
  "document_id": 1234,
  "document_ref": "doc_0123456789abcdef0123456789abcdef",
  "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
  "filename": "invoice-4711.pdf",
  "size_bytes": 48213,
  "url": "/actions/core/serve-document/doc_0123456789abcdef0123456789abcdef"
}

Get document

Get one document's index values, files and details, such as when it was stored and changed.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.

Outputs

documentobject
The document
Example output
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  }
}

Get document's workflow history

Get the DocuWare workflows a document has been through, step by step: who decided what, and when.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.

Outputs

countnumber
How many workflow runs
document_idnumber
The document
instanceslist
Each workflow run, with its steps
Example output
{
  "count": 1,
  "document_id": 1234,
  "instances": [
    {
      "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
      "name": "Invoice approval",
      "started_at": "2026-10-28T14:06:00Z",
      "steps": [
        {
          "activity": "Approve invoice",
          "activity_type": "GeneralTask",
          "date": "2026-10-28T15:30:00Z",
          "decision": "Approve",
          "step_type": "Decision",
          "user": "Jo Bloggs"
        }
      ],
      "version": 3,
      "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
    }
  ]
}

Get file cabinet

Get a file cabinet or document tray with its index fields: each field's database name, label and type.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.

Outputs

field_countnumber
How many index fields
fieldslist
Its index fields
file_cabinetobject
The file cabinet
Example output
{
  "field_count": 2,
  "fields": [
    {
      "label": "Company",
      "length": 100,
      "name": "COMPANY",
      "precision": 0,
      "system_field": false,
      "type": "Text",
      "used_as_document_name": true
    },
    {
      "label": "Document date",
      "length": 0,
      "name": "DOCUMENT_DATE",
      "precision": 0,
      "system_field": false,
      "type": "Date",
      "used_as_document_name": false
    }
  ],
  "file_cabinet": {
    "color": "Blue",
    "has_full_text_search": true,
    "id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "is_default": true,
    "is_document_tray": false,
    "name": "Records",
    "usable": true
  }
}

Get organization

Get the DocuWare organization the connection signs in to, with its name and id.

Inputs

None.

Outputs

addresstext
The DocuWare address signed in to
organizationobject
The organization
organizationslist
Every organization the user belongs to
Example output
{
  "address": "https://cityofexample.docuware.cloud",
  "organization": {
    "guid": "7a1d0c3e-5b2f-4e8a-9c6d-1f2e3a4b5c6d",
    "id": "1",
    "name": "City of Example"
  },
  "organizations": [
    {
      "guid": "7a1d0c3e-5b2f-4e8a-9c6d-1f2e3a4b5c6d",
      "id": "1",
      "name": "City of Example"
    }
  ]
}

Get task

Get one workflow task with the decisions that can be taken and what each asks for.

Inputs

DocuWare workflowdocuware_workflow_idtextRequired
The DocuWare workflow. Pick one, or give its id from an earlier step.
Instance IDinstance_idtextRequired
The task's 'instance_id', from 'List tasks' or the trigger.
Task IDtask_idtextRequired
The task's 'id', from 'List tasks' or the trigger.

Outputs

taskobject
The task
Example output
{
  "task": {
    "activity": "Approve invoice",
    "activity_type": "GeneralTask",
    "columns": {
      "COMPANY": "Example Supply Co.",
      "ReceivedOn": "2026-10-28T14:06:00Z"
    },
    "decisions": [
      {
        "description": "Approve the invoice",
        "form_fields": [
          {
            "description": "Why",
            "id": 3,
            "label": "Comment",
            "read_only": false,
            "required": false,
            "type": "Text"
          }
        ],
        "id": 1,
        "label": "Approve"
      },
      {
        "description": "Send it back",
        "form_fields": [],
        "id": 2,
        "label": "Reject"
      }
    ],
    "default_decision_id": 1,
    "document_id": 1234,
    "id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10",
    "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
    "is_read": false,
    "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
  }
}

List dialogs

List a file cabinet's dialogs (search, store, result list and so on) that the DocuWare user may use.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.
Typedialog_typetext
Only dialogs of this type. Leave empty for all.One of: Search (Search dialogs), Store (Store dialogs), ResultList (Result lists), InfoDialog (Info dialogs), TaskList (Task lists).

Outputs

countnumber
How many
dialogslist
The dialogs
Example output
{
  "count": 1,
  "dialogs": [
    {
      "assigned_dialog_id": "6e1c2b3d-4f5a-4b6c-9d7e-8f9a0b1c2d3e",
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "id": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "is_default": true,
      "name": "Search invoices",
      "type": "Search"
    }
  ]
}

List documents

List the documents in a file cabinet or document tray, newest first, with their index values. Returns one page; pass 'next_start' as 'Skip' for more.

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Orderordertext
Newest stored first (the default), oldest first, or most recently changed first.One of: newest (Newest stored first (default)), oldest (Oldest stored first), modified (Most recently changed first).
How manycountnumber
How many to return, 1 to 500. Defaults to 50.From 1 to 500.
Skipstartnumber
How many to skip, for the next page: the 'next_start' of an earlier step. Defaults to 0.At least 0.

Outputs

countnumber
How many documents this page holds
documentslist
The documents
has_moretrue/false
True when there are more to read
next_startnumber
The 'Skip' value for the next page
totalnumber
How many documents match in all
Example output
{
  "count": 1,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "has_more": false,
  "next_start": 1,
  "total": 1
}

List file cabinets

List the file cabinets and document trays the DocuWare user can see, with their ids.

Inputs

Whichcabinet_kindtext
File cabinets, document trays, or both (the default).One of: all (File cabinets and document trays (default)), cabinets (File cabinets only), trays (Document trays only).

Outputs

countnumber
How many
file_cabinetslist
The file cabinets and document trays
Example output
{
  "count": 2,
  "file_cabinets": [
    {
      "color": "Blue",
      "has_full_text_search": true,
      "id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "is_default": true,
      "is_document_tray": false,
      "name": "Records",
      "usable": true
    },
    {
      "color": "Blue",
      "has_full_text_search": false,
      "id": "b6c5d0f2-1f39-4d5e-9b62-6a8a2a5f1c10",
      "is_default": true,
      "is_document_tray": true,
      "name": "Inbox",
      "usable": true
    }
  ]
}

List my tasks

List the user's workflow tasks with their decisions: in one workflow, or in every workflow that has some.

Inputs

DocuWare workflowdocuware_workflow_idtext
Only this workflow's tasks. Leave empty for all of them.
How manycountnumber
How many to return, 1 to 500. Defaults to 50.From 1 to 500.
Skipstartnumber
With a workflow chosen, how many tasks to skip, for the next page. Defaults to 0.At least 0.

Outputs

countnumber
How many tasks this step returned
taskslist
The tasks
totalnumber
How many tasks there are in all
Example output
{
  "count": 1,
  "tasks": [
    {
      "activity": "Approve invoice",
      "activity_type": "GeneralTask",
      "columns": {
        "COMPANY": "Example Supply Co.",
        "ReceivedOn": "2026-10-28T14:06:00Z"
      },
      "decisions": [
        {
          "description": "Approve the invoice",
          "form_fields": [
            {
              "description": "Why",
              "id": 3,
              "label": "Comment",
              "read_only": false,
              "required": false,
              "type": "Text"
            }
          ],
          "id": 1,
          "label": "Approve"
        },
        {
          "description": "Send it back",
          "form_fields": [],
          "id": 2,
          "label": "Reject"
        }
      ],
      "default_decision_id": 1,
      "document_id": 1234,
      "id": "8e0c1a52-3d4b-4bb4-9f5e-2c6d1e7a9b10",
      "instance_id": "b13d1794-b4b7-5e99-91d9-0bcaa13036f3",
      "is_read": false,
      "workflow_id": "29341189-7564-4194-ba2c-33963f41891f"
    }
  ],
  "total": 1
}

List stamps

List the stamps the DocuWare user may place on a file cabinet's documents, such as Approved or Received.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many
stampslist
The stamps
Example output
{
  "count": 1,
  "stamps": [
    {
      "form_fields": [
        {
          "label": "Comment",
          "name": "<#1>"
        }
      ],
      "id": "c4a3b2d1-0e9f-4a8b-7c6d-5e4f3a2b1c0d",
      "name": "Received",
      "password_protected": false,
      "type": "TextStamp"
    }
  ]
}

List workflows

List the DocuWare workflows that have a task list for the user, with how many tasks each holds.

Inputs

None.

Outputs

countnumber
How many
workflowslist
The workflows
Example output
{
  "count": 1,
  "workflows": [
    {
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "id": "29341189-7564-4194-ba2c-33963f41891f",
      "name": "Invoice approval",
      "task_count": 2
    }
  ]
}

Place stamp

Place a stamp, such as Approved, on a page of a document. DocuWare picks a free spot on the page.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.
Stampstamp_idtextRequired
The stamp to place.
Stamp textstamp_texttext
For a stamp that asks for text, the text to put on it.
Pagepagenumber
The page to stamp. Defaults to the first.At least 1.

Outputs

annotation_countnumber
How many stamps and notes DocuWare reports on that page now
document_idnumber
The document stamped
pagenumber
The page stamped
placedtrue/false
Always true once placed
stamp_idtext
The stamp placed
Example output
{
  "annotation_count": 1,
  "document_id": 1234,
  "page": 1,
  "placed": true,
  "stamp_id": "c4a3b2d1-0e9f-4a8b-7c6d-5e4f3a2b1c0d"
}

Search documents

Find documents in a file cabinet by their index values and when they were stored. A value may use * as a wildcard, such as Exam*. Returns one page; pass 'next_start' as 'Skip' for more.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.
Index valuesconditionsobject
The values to look for, one per field. Fields left empty aren't searched. Use * as a wildcard, such as Exam*.
Stored on or afterstored_fromdate
Only documents stored on or after this date.
Stored on or beforestored_untildate
Only documents stored on or before this date.
Matchmatchtext
Whether a document must match every value (the default) or any of them.One of: all (Every condition (default)), any (Any condition).
Search dialogsearch_dialog_idtext
The search dialog to search with, which decides the fields you may search. Leave empty for the cabinet's default.
Sort bysort_fieldtext
The field to sort by. Defaults to when each was stored.
Sort ordersort_directiontext
Descending (newest or highest first, the default) or ascending.One of: Desc (Descending (default)), Asc (Ascending).
How manycountnumber
How many to return, 1 to 500. Defaults to 50.From 1 to 500.
Skipstartnumber
How many to skip, for the next page: the 'next_start' of an earlier step. Defaults to 0.At least 0.

Outputs

countnumber
How many documents this page holds
documentslist
The documents
has_moretrue/false
True when there are more to read
next_startnumber
The 'Skip' value for the next page
totalnumber
How many documents match in all
Example output
{
  "count": 1,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "has_more": false,
  "next_start": 1,
  "total": 1
}

Store document

Store a file in a file cabinet or document tray with its index values. Without a file it stores an index-only record (a data record).

Inputs

File cabinet or document trayfile_cabinet_idtextRequired
Where the document is. Pick a file cabinet or document tray, or give its id from an earlier step.
Filefiletext
The file to store: upload one, pick a file from an earlier step, or paste a public https link. Leave empty to store index values only.
Index valuesfieldsobject
Index values for the new document, one per field of the file cabinet. Dates use the date picker; for a keyword field give the keywords separated by commas. A document tray has none.
Store dialogstore_dialog_idtext
The store dialog whose rules (required fields, default values) apply. Leave empty for the file cabinet's own rules.

Outputs

documentobject
The document
document_idnumber
The new document's id
Example output
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  },
  "document_id": 1234
}

Transfer document

Move a document from a document tray (or another file cabinet) into a file cabinet, with index values, as filing it in DocuWare does. Returns the filed document.

Inputs

To file cabinetfile_cabinet_idtextRequired
The file cabinet to file the document in.
Fromsource_file_cabinet_idtextRequired
The document tray or file cabinet the document is in now.
Document IDdocument_idtextRequired
The document's id where it is now, from a list, a trigger or an earlier step.
Index valuesfieldsobject
Index values for the filed document, one per field of the file cabinet it goes to. Dates use the date picker.
Keep a copy where it waskeep_sourcetrue/false
Leave the original where it was. By default it is moved.
Store dialogstore_dialog_idtext
The store dialog of the file cabinet it goes to. Leave empty for that cabinet's default.

Outputs

documentobject
The document
document_idnumber
The filed document's id in the file cabinet
documentslist
Every document filed
kept_sourcetrue/false
True when the original was kept
source_document_idnumber
The document's id where it was
Example output
{
  "document": {
    "content_type": "application/pdf",
    "field_list": [
      {
        "is_null": false,
        "label": "Company",
        "name": "COMPANY",
        "read_only": false,
        "system_field": false,
        "type": "String",
        "value": "Example Supply Co."
      },
      {
        "is_null": false,
        "label": "Document date",
        "name": "DOCUMENT_DATE",
        "read_only": false,
        "system_field": false,
        "type": "Date",
        "value": "2026-10-20"
      },
      {
        "is_null": false,
        "label": "Stored on",
        "name": "DWSTOREDATETIME",
        "read_only": true,
        "system_field": true,
        "type": "DateTime",
        "value": "2026-10-28T14:05:00Z"
      }
    ],
    "fields": {
      "COMPANY": "Example Supply Co.",
      "DOCUMENT_DATE": "2026-10-20",
      "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
    },
    "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
    "file_size": 48213,
    "id": 1234,
    "is_checked_out": false,
    "is_data_record": false,
    "modified_at": "2026-10-28T14:05:00Z",
    "section_count": 1,
    "sections": [
      {
        "content_type": "application/pdf",
        "file_size": 48213,
        "id": "1234-5678",
        "original_file_name": "invoice-4711.pdf",
        "page_count": 2
      }
    ],
    "stored_at": "2026-10-28T14:05:00Z",
    "title": "Invoice 4711",
    "total_pages": 2,
    "version_status": "Disable"
  },
  "document_id": 1234,
  "documents": [
    {
      "content_type": "application/pdf",
      "field_list": [
        {
          "is_null": false,
          "label": "Company",
          "name": "COMPANY",
          "read_only": false,
          "system_field": false,
          "type": "String",
          "value": "Example Supply Co."
        },
        {
          "is_null": false,
          "label": "Document date",
          "name": "DOCUMENT_DATE",
          "read_only": false,
          "system_field": false,
          "type": "Date",
          "value": "2026-10-20"
        },
        {
          "is_null": false,
          "label": "Stored on",
          "name": "DWSTOREDATETIME",
          "read_only": true,
          "system_field": true,
          "type": "DateTime",
          "value": "2026-10-28T14:05:00Z"
        }
      ],
      "fields": {
        "COMPANY": "Example Supply Co.",
        "DOCUMENT_DATE": "2026-10-20",
        "DWSTOREDATETIME": "2026-10-28T14:05:00Z"
      },
      "file_cabinet_id": "0242b887-0261-473d-aa59-96eb5cd5f709",
      "file_size": 48213,
      "id": 1234,
      "is_checked_out": false,
      "is_data_record": false,
      "modified_at": "2026-10-28T14:05:00Z",
      "section_count": 1,
      "sections": [
        {
          "content_type": "application/pdf",
          "file_size": 48213,
          "id": "1234-5678",
          "original_file_name": "invoice-4711.pdf",
          "page_count": 2
        }
      ],
      "stored_at": "2026-10-28T14:05:00Z",
      "title": "Invoice 4711",
      "total_pages": 2,
      "version_status": "Disable"
    }
  ],
  "kept_source": false,
  "source_document_id": 87
}

Update index values

Change a stored document's index values. Only the fields given change.

Inputs

File cabinetfile_cabinet_idtextRequired
The file cabinet. Pick one, or give its id from an earlier step.
Document IDdocument_idtextRequired
The document's id, a whole number, from a search, a list, a trigger or an earlier step.
Index valuesfieldsobjectRequired
Index values to set, one per field of the file cabinet. Dates use the date picker; for a keyword field give the keywords separated by commas. Fields left empty are left as they are.

Outputs

changedlist
The fields this step changed
document_idnumber
The document changed
field_listlist
Every index field now
fieldsobject
Every index field's database name with its value now
Example output
{
  "changed": [
    "COMPANY"
  ],
  "document_id": 1234,
  "field_list": [
    {
      "is_null": false,
      "label": "Company",
      "name": "COMPANY",
      "read_only": false,
      "system_field": false,
      "type": "String",
      "value": "Example Supply Co."
    },
    {
      "is_null": false,
      "label": "Document date",
      "name": "DOCUMENT_DATE",
      "read_only": false,
      "system_field": false,
      "type": "Date",
      "value": "2026-10-20"
    }
  ],
  "fields": {
    "COMPANY": "Example Supply Co.",
    "DOCUMENT_DATE": "2026-10-20"
  }
}

On this page