Group Paging Capacity

Retrieve the current capacity

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_paging_capacity/

Retrieve the the maximum number of targets allowed for a paging group in this Group. The maximum value defined at Tenant level is also provided.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/group_paging_capacity/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "maximumTargetUsersFromTenant": 140,
  "maximumTargetUsers": 80
}

Response JSON Object:

• maximumTargetUsersFromTenant (integer) – The maximum capacity defined at Tenant level.

• maximumTargetUsers (integer) – The maximum capacity defined at Group level (lower or equal to the one at Tenant level).

Status Codes:

• 200 OK –

Modify the capacity

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/group_paging_capacity/

Modify the the maximum number of targets allowed for a paging group for this Group.

Authorization rights: minimum Tenant Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/group_paging_capacity/ HTTP/1.1
Host: example.com

{
  "maximumTargetUsers": 80
}

Request JSON Object:

• maximumTargetUsers (integer) – The bew maximum capacity for the Group (must be lower or equal to the one at Tenant level).

Example response:

HTTP/1.1 200 OK

{
  "maximumTargetUsersFromTenant": 140,
  "maximumTargetUsers": 80
}

Response JSON Object:

• maximumTargetUsersFromTenant (integer) – The maximum capacity defined at Tenant level.

• maximumTargetUsers (integer) – The maximum capacity defined at Group level (lower or equal to the one at Tenant level and lower or equal to 294).

Status Codes:

• 200 OK – success

• 400 Bad Request – unable to update due to wrong new capacity, with two usual use case: bigger than Tenant level or bigger than 294.