Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The limits resource provides limits associated with the organization (such as scheduled tasks for ArcGIS Notebooks, Workflow Manager, or geoprocessing services) for individual users and for an organization as a whole. Limits can be updated using the Update Limits operation.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| 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 |
| 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 maximum number of scheduled recurring workflow manager jobs that can be created by an individual user. |
| The maximum total number of scheduled recurring workflow manager jobs for an organization. |
| 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 |
| 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 permanently deleted. |
| The maximum number of active scheduled geoprocessing service tasks that can be owned by an individual user. |
| 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:
https://organization.example.com/<context>/admin/system/limits?f=jsonJSON Response syntax
{
"ScheduleTask": [
{
"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
{
"ScheduleTask": [
{
"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
}
]
}