Skip To Content
ArcGIS Developer

/[workspaceID]/schedule: Schedule

  • URL:https://[root]/portals/[portalID]/collaborations/[collaborationID]/workspaces/[workspaceID]/schedule
  • Operations:Delete, Pause, Resume, Update
  • Version Introduced:10.6

Example usage

Below is a sample ArcGIS Online POST request for the schedule resource:

Below is a sample ArcGIS Enterprise POST request for the schedule resource:


Collaboration guests can use the schedule resource to return a job schedule for synchronized items in a collaboration workspace. The response is a single JSON object that represents a job schedule.

Request parameters


The response format. The default format is html.

Values: html | json | pjson

Response properties


A positive integer that represents time (in hours) between each job trigger. The default interval is 24 hours.


A positive integer or -1 which represents how many times to keep re-triggering this job after which it will be automatically deleted. The default is -1 which means repeat indefinitely.


Count of times the job schedule has been triggered.


A job's scheduled start time. The startTime is in Unix time in milliseconds. The default is the current time of the request call.


The next scheduled fire time for a job. The nextFireTime is in Unix time in milliseconds.


Specifies the current condition of the job and includes the following returned values:

  • Normal: The scheduled synchronization is operating as prescribed.
  • Complete: The job is complete and has no outstanding triggers to fire upon.
  • Blocked: Another job is in progress. This job will be blocked until the existing job completes.
  • Error: An error occurred and prohibited the job from starting.

JSON Response example

  "interval": 24,
  "repeatCount": -1,
  "timesTriggered": 1,
  "startTime": 1525218023938,
  "nextFireTime": 1525304423938,
  "state": "NORMAL"