Limits

This documentation provides information about API for system limits.

API

GET /api/limits/

Permissions

Requires authentication and SuperAdmin permission.

Request

• Headers

Content-Type: application/json
Authorization: JWT access_token

• Schema

GET /api/limits/

Response

Key	Type	Notes
object_classes	object	Count and limits of object classes.
task_group_templates	object	Count and limits of task group templates.
task_templates	object	Count and limits of task templates.
sequences	object	Count and limits of sequences.
user_groups	object	Count and limits of user groups.
roles	object	Count and limits of roles.
single_sign_on_configurations	object	Count and limits of single sign-on configurations.
authentication_objects	object	Count and limits of authentication objects.
custom_components	object	Count and limits of custom components.
additional_limits	object	Additional limits for which count is not available.

Individual response objects

Key	Type	Notes
count	int	The current number of objects.
limit	int	The maximum permitted number of objects.

Response additional_limits object

Key	Type	Notes
object_class_fields	int	Limit of fields per object class.
object_records_per_object_class	int	Limit of records per object class.
user_group_members	int	Limit of user group members.
object_record_owners	int	Limit of object record owners.
object_class_owners	int	Limit of object class owners.
object_class_permission_sets	int	Limit of permission sets per object class.
object_class_permission_set_assignees_users	int	Limit of users as assignees per permission set in object class.
object_class_permission_set_assignees_user_groups	int	Limit of user groups as assignees per permission set in object class .
task_assignees_users	int	Limit of of users as default task assignees.
task_assignees_user_groups	int	Limit of of user groups as default task assignees.
user_group_owners	int	Limit of user group owners.
object_class_forms	int	Limit of standalone forms per object class.
records_permission_sets	int	Limit of record permission sets.
object_record_permission_set_assignees_users	int	Limit of users as assignees in object record permission sets.
object_record_permission_set_assignees_user_groups	int	Limit of user groups as assignees in object record permission sets.
object_class_document_templates	int	Limit of document templates per object class.
ui_configs	int	Limit of UI configurations.
object_relations_children	int	Limit of children in object relations.
object_relations_depth	int	Limit of depth in object relations.
object_relations_top_parents	int	Limit of top-level parents in object relations.
user_preferences	int	Limit of user preferences.
public_files	int	Limit of public files.
user_group_permission_sets	int	Limit of user group permission sets per group.
users_group_permission_set_assignees_users	int	Limit of users as assignees per permission set per user group.
users_group_permission_set_assignees_user_groups	int	Limit of user groups as assignees per permission set per user group.

• Successful status 200 OK
• Response body schema

{
  "object_classes": {
    "count": "<int>",
    "limit": "<int>"
  },
  "task_group_templates": {
    "count": "<int>",
    "limit": "<int>"
  },
  "task_templates": {
    "count": "<int>",
    "limit": "<int>"
  },
  "sequences": {
    "count": "<int>",
    "limit": "<int>"
  },
  "user_groups": {
    "count": "<int>",
    "limit": "<int>"
  },
  "roles": {
    "count": "<int>",
    "limit": "<int>"
  },
  "single_sign_on_configurations": {
    "count": "<int>",
    "limit": "<int>"
  },
  "authentication_objects": {
    "count": "<int>",
    "limit": "<int>"
  },
  "custom_components": {
    "count": "<int>",
    "limit": "<int>"
  },
  "additional_limits": {
    "object_class_fields": "<int>",
    "object_records_per_object_class": "<int>",
    "user_group_members": "<int>",
    "object_record_owners": "<int>",
    "object_class_owners": "<int>",
    "object_class_permission_sets": "<int>",
    "object_class_permission_set_assignees_users": "<int>",
    "object_class_permission_set_assignees_user_groups": "<int>",
    "task_assignees_users": "<int>",
    "task_assignees_user_groups": "<int>",
    "user_group_owners": "<int>",
    "object_class_forms": "<int>",
    "records_permission_sets": "<int>",
    "object_record_permission_set_assignees_users": "<int>",
    "object_record_permission_set_assignees_user_groups": "<int>",
    "object_class_document_templates": "<int>",
    "ui_configs": "<int>",
    "object_relations_children": "<int>",
    "object_relations_depth": "<int>",
    "object_relations_top_parents": "<int>",
    "user_preferences": "<int>",
    "public_files": "<int>",
    "user_group_permission_sets": "<int>",
    "users_group_permission_set_assignees_users": "<int>",
    "users_group_permission_set_assignees_user_groups": "<int>"
  }
}

Errors

Standard validation errors.