NovaStar Data / Service Parameter / group
Overview
The groupId and groupName service parameters are used to filter NovaStar data to a user group.
In dedicated NovaStar systems that manage data for a single organization, the group is typically optional for web services because reading data is generally not restricted. Groups may be used to define different operational units that are interested in specific data. The group limits access to editing features in the Administrator.
In multi-tenant NovaStar systems that manage data for multiple organizations, such as NovaStar Cloud, the group is used to identify the organization and is required. For example, NovaStar Cloud uses the TriLynx system identifier for the group. Additional access restrictions are implemented using an API key.
See the groups service to list groups.
The following services have group filters:
Services with Group Filter
| Service | Comments |
|---|---|
maps |
|
plots |
|
stations |
Station data may be used to restricts access to other related data. |
stationStatistics |
|
stationSummaries |
|
ts |
|
tscatalog |
Service Parameter Editor
The api-ui service can be used to edit a service request.
Service Parameter Syntax
The parameter syntax is as follows:
Service Parameter Values
| Value | Description |
|---|---|
groupId |
The internal database group identifier, typically used by software that handles queries. |
groupName |
The group name to use as a data filter. |
Examples
See the syntax section above.
Troubleshooting
If filtering by group(s) does not return expected data, review the user group configuration in the NovaStar Administrator.
See Also
- Services: