Get Document

Retrieve a Documents DataTabs.

GET/v1/documents/:id?dataTab=:dataTabId

Path Parameters

id: string

The Document Id.

Query Parameters

dataTabId: string (optional)

The DataTab Id to filter for. If defined only the single DataTab will be returned.

Success Response

200 Ok

{
    "name": "The document name",
    "layout": "lyt_2nulpOUb7F5JALgRaq3brb",
    "dataTabs": [
        {
            "id": "dt_47Jt6IwXmYomwAhBkbcgI1",
            "label": "Workflow status",
            "value": "Completed without Errors",
            "status": "Ok",
            "updatedOn": 1767222000
        }
    ]
}

name: string

The Document name.

layout: string

The Layout id.

dataTabs: dataTab[]

All DataTabs of the document. If filtered by query parameter only the filtered DataTab. If it does not exist, the array is empty.

dataTab.id: string

The DataTab Id.

dataTab.label: string

The DataTab label as defined in the layout.

dataTab.value: string | number | boolean | (optional)

The DataTab Value. Depending on the DataTab data type it will be a string, number, boolean or null. A reference to another document will return the id of the document as a string.

dataTab.status: "Off" | "Neutral" | "Ok" | "Warning" | "Error" (optional)

The DataTab status. Depending on the DataTab settings a status might be submitted.

dataTab.updatedOn: number (optional)

The Unix UTC Timestamp this DataTab Value was last updated. If it was never written it will be null.