/[workspaceID]/sync: Sync

URL:
https://[root]/portals/[portalID]/collaborations/[collaborationID]/workspaces/[workspaceID]/sync
Methods:
POST
Version Introduced:
10.6.1

Example usage

The following is a sample ArcGIS Online POST request for the sync operation:

1
2
3
4
5
6
POST /sharing/rest/portals/0123456789ABCDEF/collaborations/3e9d1694351a4b5badef66c7599fced5/workspaces/c3c831f1274a4f228ecd87f1953c6f21/sync HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson

The following is a sample ArcGIS Enterprise POST request for the sync operation:

1
2
3
4
5
6
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/collaborations/3e9d1694351a4b5badef66c7599fced5/workspaces/c3c831f1274a4f228ecd87f1953c6f21/sync HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson

Description

The sync operation is provided to allow execution of a data sync on a particular workspace. The operation is allowed on the participant that is designated to initiate sync operations as determined during trust establishment between the collaboration host and a guest participant. Typically, the guest participant is designated to initiate sync operations. Note that if a scheduled sync operation is already in progress a new sync is not started unless the current sync operation is finished.

When running sync in synchronous mode, the client will be blocked until the operation is completed. Invoking sync in synchronous mode is good for quickly syncing an item (that is not large) if the client does not want to wait for the next scheduled sync.

Asynchronous mode allows a client to get response immediately so it does not have to wait and is not blocked from performing other tasks.

Request parameters

ParameterDetails

f

The response format. The response format is html.

Values: html | json | pjson

async

Boolean value. When true, the job will run asynchronously.

Values: true | false

JSON Response example

1
2
3
4
5
{
  "jobId": "cd8d04b3d27a474fb070df3665e804e6",
  "key": "WC6bISkKe4lUYMs2BA132T/rXxcjORFWdB5vp/91ukU=",
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close