Skip to main content

form-inputs

Values entered into forms, with comments and status.

📄️List form inputs (paged)

Returns a page of form inputs matching the given filters (measured-at range, last-modified range, form id and status), using the supplied page number, size and sort. Each input comes with its element values and the comments written for them on publishing (HET-1969). The sort is made unique with the input's id, so paging through inputs with the same measurement time shows each of them exactly once. The response includes the items plus current page and total item count, and how the inputs of the time range are spread across the statuses. Both ranges take relative expressions such as now-30d, resolved per request in `timeZone`.

📄️Create or update a form input

Upserts a form input with its per-element values and comments. When the saved status is PUBLISHED the numeric and calculation field values are written as time-series data points for the form, and the comments of the input's previous publishing are replaced by the ones sent - linked to this input, so a comment of another input or one set in a plot at the same time is left alone (HET-1973). Status RECALLED withdraws the release so that the values can be adjusted: the data points are rolled back out of the time series - where a signal held a value at that time before, that value is back - and the comments are deleted, until the input is published again (HET-2053).