usergroup

UserGroup Search

Changed on

Search User Groups

get/group

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/group
  • Auth
    none declared

Query parameters

userGroupIdinteger

Filter by UserGroup Id

userGroupstring

Filter by UserGroup Name

sortBy'groupId' | 'group' | 'description' | 'libraryQuota' | 'isSystemNotification' | 'isDisplayNotification' | 'isDataSetNotification' | 'isLayoutNotification' | 'isLibraryNotification' | 'isReportNotification' | 'isScheduleNotification' | 'isCustomNotification' | 'isShownForAddUser'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

groupIdinteger

The Group ID

groupstring

The group name

isUserSpecificinteger

A flag indicating whether this is a user specific group or not

isEveryoneinteger

A flag indicating the special everyone group

descriptionstring

Description of this User Group

libraryQuotainteger

This users library quota in bytes. 0 = unlimited

isSystemNotificationinteger

Does this Group receive system notifications.

isDisplayNotificationinteger

Does this Group receive display notifications.

isDataSetNotificationinteger

Does this Group receive DataSet notifications.

isLayoutNotificationinteger

Does this Group receive Layout notifications.

isLibraryNotificationinteger

Does this Group receive Library notifications.

isReportNotificationinteger

Does this Group receive Report notifications.

isScheduleNotificationinteger

Does this Group receive Schedule notifications.

isCustomNotificationinteger

Does this Group receive Custom notifications.

isShownForAddUserinteger

Is this Group shown in the list of choices when onboarding a new user

defaultHomepageIdstring

Default Home page for new users

featuresstring[]

Features this User Group has direct access to

Changes