Skip To Content
ArcGIS Developers
Dashboard

workspaces: Workspaces

  • URL:https://[root]/portals/[portalID]/collaborations/[collaborationID]/workspaces
  • Child Resources:Workspace
  • Required Capability:Administrator
  • Version Introduced:10.5

Example usage

Below is a sample ArcGIS Online request URL used to access the workspaces resource:

https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/collaborations/1169d622be9d49c58d53dcfc4cd85134/workspaces?f=pjson

Below is a sample ArcGIS Enterprise request URL used to access the workspaces resource:

https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/collaborations/1169d622be9d49c58d53dcfc4cd85134/workspaces?f=pjson

Description

The workspaces resource lists all the workspaces in a given collaboration. A workspace is a virtual space in the collaboration to which each participating portal is either sending or receiving content. Workspaces can only be created by the collaboration owner. To create a new workspace use the Add Workspace operation.

Request parameters

ParameterDetails
f

The response format. The default value is html.

Values: html | json | pjson

JSON Response example

{
  "total": 1,
  "start": 1,
  "num": 25,
  "nextStart": -1,
  "workspaces": [
    {
      "id": "ba18f61f703741599dc8d888984c0da1",
      "name": "MPlanningRedlands",
      "description": "Municipal planning",
      "collaborationId": "6eb9d44f520747468926620047e79919",
      "config": {
        "maxItemSizeInMB": 512,
        "maxReplicationPackageSizeInMB": 1024,
        "copyByRefIfCopyFail": true,
        "bidirectionalSyncCapable": true
      },
      "created": 1602454347620,
      "modified": 1602454347620,
      "lastSyncSuccess": -1,
      "bidirectionalSyncCapable": false,  //New with ArcGIS Online's March 2021 release
      "participantGroupLinks": [
        {
          "portalId": "cd16dea4-9c99-4662-b337-9734843a65a9",
          "portalGroupId": "845cc726affd46a3a0431635f7861364",
          "portalGroupName": "MPlanningRedlands",
          "config": {
            "enableRealtimeSync": true,
            "copyFeatureServiceData": true,
            "enableFeatureServiceBidirectionalSync": false
          },
          "accessMode": "sendAndReceive",
          "canSyncWorkspace": true,
          "isServiceProxyEnabled": false
        },
        {
          "portalId": "wTpiCNYUNGm0YDTX",
          "accessMode": "sendAndReceive",
          "config": {
            "copyFeatureServiceData": true,
            "enableFeatureServiceBidirectionalSync": true
          },
          "isServiceProxyEnabled": false
        }
      ],
      "participantsWithoutGroupLinks": []
    }
  ]
}