Update Document

Update the Document.

PATCH/v1/documents/:id

Path Parameters

id: string

The Document Id.

Request Body

Content-Type: application/json

{
    "dataTab": "dt_47Jt6IwXmYomwAhBkbcgI1",
    "value": "The new Value here",
    "status": "Ok"
}

dataTab: string

The DataTab Id to update within this document.

value: string | number | boolean (optional)

The new DataTab value. Depending on the DataTab data type it has to be a string, number or boolean. Optional if a status is submitted. If only the status is submitted the current value is kept.

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

The new DataTab status. Can only be set if the DataTab supports it. Optional if a value is submitted. If only the value is submitted the current status is kept.

Success Response

200 Ok