Update metric report

Full update of a metric report: values are matched by metric id, and a metric omitted from the request has its recorded value removed. Editing a published report requires full metrics write access; set published to false to revert it to a draft. First retrieve the current report from /api/reporting/metrics/reports/{id}, apply your changes, then send back the full object. Creating or editing a draft requires Limited Write Metrics; publishing a report, or editing one that is already published, additionally requires Full Write Metrics.

Required permission: Limited Write Metrics

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the metric report.

Body Params

The metric report details

date
required

The date the report covers.

subgroup
object | null
required

The subgroup the report was submitted for. Provide the id when saving.

string | null

Notes entered on the report (max 4000 characters).

boolean | null

Whether the report has been published. Set true to publish (requires full metrics write access), false to revert to a draft, or omit to leave unchanged.

values
array of objects | null

The full metric tree with each metric's recorded value merged in. When saving, set a value on each counted metric, with sub-metrics nested under children.

values
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json