Reporting dashboards and targets
Rename a dashboard group
/a/ReportDashboardGroup_setName
Change a dashboard group’s display name.
When to use this endpoint
Load the saved dashboard/group configuration first, then send this edit from its settings or layout controls. Re-read the configuration after an uncertain write: the handler reports validation, permission, lookup, and write failures as application errors.
Authentication and permissions
Authenticate with signed API-key fields or a logged-in CRM session. All lookups and writes are tenant-local.
Only the group owner may manage its name, sharing/settings, or deletion. View/edit shares do not grant group-management rights. None disables its share array; otherwise string user IDs or All grant that share. No reporting-feature or additional CRM2 page-role check is applied.
For signed form requests, sign numeric scalar values as strings, including values inside native nested arrays. Send JSON text only for parameters explicitly accepting JSON strings; see Getting started.
These reporting handlers require tenant schema upgrade 794 before deployment. No request path creates or repairs schema.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | Integer-compatible | Yes | Positive integer ID in the authenticated tenant. Malformed, fractional, zero, or negative values are rejected; deleted records are unavailable. |
val | String | Yes | Trimmed, nonblank name, maximum 100 characters. |
Example request
$result = FM_api('ReportDashboardGroup_setName', ['id'=> '12','val'=>'Quarterly sales']);Example response
{"ok":"1"}Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
{"error":"missing or invalid parameter: id"} | Required id is absent or invalid. |
{"error":"missing or invalid parameter: val"} | Required val is absent or invalid or blank. |
{"error":"parameter too long: val. max length 100 characters"} | The trimmed name exceeds the 100-character limit. |
{"error":"no permission to access api"} | The group is not readable/editable, or the operation requires ownership and the caller is not its owner. |
{"error":"reporting write failed"} | A database write failed. Transactional operations roll back instead of returning success. |
{"error":"report group is not existing."} | The group is missing or deleted. |
{"ok":"1","warning":"no change required"} | The trimmed name equals the saved name. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Only the owner may rename an active group. Duplicate names are allowed.
- Stored NULL/blank names can be repaired; no-change detection compares trimmed unescaped text.
Side effects
- Updates the stored value and Unix
last_edited, invalidating the corresponding table cache. No activity history, notification, generic edit event, or tenant deletion-stream entry is written.
See it in Fieldmotion
CRM1
Rename the selected report dashboard group. Filter browser Network requests for ReportDashboardGroup_setName.
CRM2
Rename a dashboard group from its settings/list editor. Filter browser Network requests for ReportDashboardGroup_setName.
Related endpoints
ReportDashboardGroups_listfinds groups visible to the current user.ReportDashboards_listloads stored widget configuration.ReportDashboardGroup_setMetaedits group metadata and sharing.