Create report group

Create a top-level report group with its subgroups. Reports are submitted to a group's subgroups, and at least one active subgroup is required. The caller needs the metrics settings permission at the group's campuses (a subgroup follows its parent) and at every campus the body names; otherwise the request is refused with a 403 HTTP response.

Required permission: Metrics Settings

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The report group details

string | null
required

The name of the report group (max 100 characters).

int32

The unique id of the report group. Providing an existing group's id updates that group instead of creating a new one. When updating a group, keep each existing subgroup's id; subgroups without an id are created.

string | null

The abbreviation shown for the group where space is limited (max 5 characters, stored uppercase). Required on top-level groups; not used on subgroups.

string | null

The display color of the group (hex code). Required on top-level groups; not used on subgroups.

boolean

Whether the group is active.

campuses
array of objects | null

The campuses the group belongs to, ordered by name; empty when it is available to every campus. Only a
top-level group carries a set: subgroups follow their parent and ignore this property. On writes, send the
ids to set the campus set (an empty list means every campus); omit the property to leave the set unchanged.
A campus-limited caller can only add or remove campuses within their access and cannot change whether the
group is available to every campus.
Ignored while multi-campus is off.

campuses
organizations
array of objects | null

The organizations this record is scoped to, all their campuses now and in the future, in name order; empty
unless the record is organization-scoped (then campuses is empty). Honoured only while multi-org is
on. Omit to keep the current organizations.

organizations
subgroups
array of objects | null

The group's subgroups, including inactive ones. Subgroups carry a name and active flag only; at least one active subgroup is required.

subgroups
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