Limits

URL:: https://<root>/system/limits
Methods:: GET
Required Capability:: Access allowed with either the "Security and Infrastructure" or "Organization Website" privileges
Version Introduced:: 11.2

Description

The limits resource provides limits associated with the organization (such as scheduled tasks for ArcGIS Notebooks, Workflow Manager, ArcGIS Insights, or geoprocessing services) for individual users and the for an organization as a whole.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Response properties

Property	Details
`UpdateInsightsUserLimit`	The maximum number of scheduled Insight reports that can be created by an individual user.
`UpdateInsightsOrgLimit`	The maximum total number of scheduled Insight reports for an organization.
`ExecuteNotebooksUserLimit`	The maximum number of active scheduled notebook tasks that can be owned by an individual user. By default, a user can only own 20 active notebooks tasks. When this limit is reached, the user will not be able to create a new notebook task until one of the notebook tasks change its status from `Active` to `Complete`, `Failed`, or `Inactive`. The number of ownable active tasks can be updated using the Update Limits operation.
`ExecuteNotebooksOrgLimit`	The maximum number of total active scheduled notebook tasks for an organization. By default, an organization is limited to 200 active notebook tasks. When this limit is reached, users will not be able to create any additional notebook tasks. The number of total active tasks for an organization can be updated using the Update Limits operation.
`ExecuteWorkflowManagerUserLimit`	The maximum number of scheduled recurring workflow manager jobs that can be created by an individual user.
`ExecuteWorkflowManagerOrgLimit`	The maximum total number of scheduled recurring workflow manager jobs for an organization.
`FailedRunsToDisableTask`	The number of times a task can fail consecutively before it is switched to a failed state. By default, a task can fail 5 times. When this limit is met, the task is changed from its active state, and the task owner must identify and rectify the issue before switching the task's access back to Active. The failure limit can be updated using the Update Limits operation.
`TaskRunHistoryCount`	The total number of runs that are reported and maintained for a scheduled task. By default, only the 30 most recent runs will be maintained. Any tasks that are not within the most recent 30 runs will be permanetly deleted. The number of runs can be increased to a total of 50 runs per scheduled task using the Update Limits operation.
`GPServiceUserLimit`	The maximum number of active scheduled geoprocessing service tasks that can be owned by an individual user.
`GPServiceOrgLimit`	The maximum total number of active scheduled geoprocessing service tasks for an organization.

Example usage

The following is a sample request URL used to access the limits resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/portaladmin/system/limits?f=json

JSON Response syntax

Use dark colors for code blocksCopy
{
  "ScheduleTask": [
    {
      "limitName": "UpdateInsightsOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteNotebooksUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteNotebooksOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteWorkflowManagerUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteWorkflowManagerOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "GPServiceUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "GPServiceOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "FailedRunsToDisableTask",
      "numLimit": <number>
    },
    {
      "limitName": "TaskRunHistoryCount",
      "numLimit": <number>
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "ScheduleTask": [
    {
      "limitName": "UpdateInsightsUserLimit",
      "numLimit": 20
    },
    {
      "limitName": "UpdateInsightsOrgLimit",
      "numLimit": 50
    },
    {
      "limitName": "ExecuteNotebooksUserLimit",
      "numLimit": 20
    },
    {
      "limitName": "ExecuteNotebooksOrgLimit",
      "numLimit": 200
    },
    {
      "limitName": "ExecuteWorkflowManagerUserLimit",
      "numLimit": 30
    },
    {
      "limitName": "ExecuteWorkflowManagerOrgLimit",
      "numLimit": 100
    },
    {
      "limitName": "GPServiceUserLimit",
      "numLimit": 20
    },
    {
      "limitName": "GPServiceOrgLimit",
      "numLimit": 100
    },
    {
      "limitName": "FailedRunsToDisableTask",
      "numLimit": 5
    },
    {
      "limitName": "TaskRunHistoryCount",
      "numLimit": 30
    }
  ]
}