Skip to main content
Workspaces are the top-level organizational units in CData Sync. A workspace contains connections, jobs, transformations, pipelines, and related execution history. The Sync REST API V2 provides endpoints to create, retrieve, update, and delete workspaces, and to access the resources that belong to a workspace. All workspace endpoints are available under this versioned base path: 
/api.rsc/v2/workspaces
The REST API supports the following workspace management actions: The following sections describe each of these actions.

​
List All Workspaces

The following command returns a list of all workspaces that the authenticated user can access: 
GET http://<SyncHost>/api.rsc/v2/workspaces
Path Parameter
NameDescription
workspacesLists all Sync workspaces.

​
Retrieve Workspace Details

The following command returns details for a specific workspace: 
GET http://<SyncHost>/api.rsc/v2/workspaces/{workspace-Id}
Path Parameter
NameDescription
workspace-id (required)Identifies the workspace for which you want to retrieve details.

​
Create a Workspace

The following command creates a new workspace: 
POST http://<SyncHost>/api.rsc/v2/workspaces
Path Parameter
NameDescription
workspaces (required)Specifies the workspace collection in which the new workspace should be created.
Body Parameters
NameDescription
IdIdentifies the workspace.
Name (required)Specifies the name of a new workspace.
ConnectionsSpecifies a list of connectors in a workspace, and it includes the identifier (Id) and the name.
TransformationsSpecifies a list of transformations in the workspaceand it includes the identifier (Id) and the name.
Is_DefaultA Boolean value that specifies whether a workspace is the default workspace.
Created_AtSpecifies when a workspace was created. TThe value is returned in Coordinated Universal Time (UTC) and is formatted according to the ISO 8601 date and time standard.
Updated_AtSpecifies when a workspace is updated. The value is returned in Coordinated Universal Time (UTC) and is formatted according to the ISO 8601 date and time standard.
Permissions.Can_UpdateA Boolean value that specifies whether the current user can update a workspace.
Permissions.Can_DeleteEnables the user to delete a workspace.
Example Request 
{
  "name": "MyNewWorkspace",
}

​
Update a Workspace Name

The following command modifies the name of an existing workspace: 
PUT http://<SyncHost>/api.rsc/v2/workspaces/{workspace-id}
Path Parameter
NameDescription
workspace-id (required)Identifies the workspace for which you want to to update the name.
Body Parameter
NameDescription
NameSpecifies the updated name of the workspace.
Example Request 
{
  "name": "ModifiedWorkspaceName"
}

​
Delete a Workspace

The following command removes a workspace: 
DELETE http://<SyncHost>/api.rsc/v2/workspaces/{workspace-id}
Path Parameter
NameDescription
workspace-id (required)Identifies the workspace that you want to delete.