Group Paging Capacity¶

Retrieve the current capacity¶

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

Retrieve the the maximum number of targets allowed for a paging group in this Tenant. All Groups in this Tenant will be allowed to define their own capacity with a value lower or equal to the one defined at Tenant level.

Authorization rights: minimum Tenant Admin.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
  "maximumTargetUsers": 80
}

Response JSON Object:

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

Status Codes:

200 OK –

Modify the capacity¶

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

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

Authorization rights: minimum System Admin.

Example request:

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

{
  "maximumTargetUsers": 80
}

Request JSON Object:

maximumTargetUsers (integer) – The bew maximum capacity for the Tenant (must be lower or equal to 294).

Example response:

HTTP/1.1 200 OK

{
  "maximumTargetUsers": 80
}

Response JSON Object:

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 the usual use case: bigger than 294.