/addWorkspace: Add Workspace

URL:
https://[root]/portals/[portalID]/collaborations/[collaborationID]/addWorkspace
Methods:
POST
Required Capability:
Administrator (host)
Version Introduced:
10.5

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /sharing/rest/portals/0123456789ABCDEF/collaborations/3e9d1694351a4b5badef66c7599fced5/addWorkspace HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

collaborationWorkspaceName=Test Workspace&collaborationWorkspaceDescription=Test Workspace for distributed collaboration&portalGroupId=a47d414ceccf447bb0b92adbf189e93e&f=pjson

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/collaborations/3e9d1694351a4b5badef66c7599fced5/addWorkspace HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

collaborationWorkspaceName=Test Workspace&collaborationWorkspaceDescription=Test Workspace for distributed collaboration&portalGroupId=a47d414ceccf447bb0b92adbf189e93e&f=pjson

Description

The addWorkspace resource adds a new workspace to a distributed collaboration. Only collaboration hosts can create new workspaces.

Request parameters

ParameterDetails

collaborationWorkspaceName

The name of the new workspace. The workspace name has a limit of 100 characters.

Example

Use dark colors for code blocksCopy
1
collaborationWorkspaceName=Test Workspace

collaborationWorkspaceDescription

The description of the new workspace. The workspace description has a limit of 250 characters.

Example

Use dark colors for code blocksCopy
1
collaborationWorkspaceDescription=Test Workspace for distributed collaboration

portalGroupId

The ID of the portal group linked with the workspace.

Example

Use dark colors for code blocksCopy
1
portalGroupId=a47d414ceccf447bb0b92adbf189e93e

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails

collaborationWorkspaceId

The ID of the new workspace.

collaborationId

The ID of the collaboration where the workspace was created.

success

Returns the status of whether the operation was successful. Returns true if so.

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "success": true,
  "workspace": {
    "id": "b8895fa6e10d479cab11858d06df30ab",
    "name": "Test Workspace",
    "description": "Test Workspace for distributed collaboration",
    "collaborationId": "3e9d1694351a4b5badef66c7599fced5",
    "config": {
      "maxItemSizeInMB": 1024,
      "maxReplicationPackageSizeInMB": 5120,
      "bidirectionalSyncCapable": true
    },
    "created": 1615594027324,
    "modified": 1615594027324,
    "lastSyncSuccess": -1
  }
}

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