# Workspaces

​ A workspace is a collaboration context for the two involved parties. At least one party must be authorized to create a workspace and invite another party to it. The workspace becomes a shared place for the electronic documents and catalogs created by these parties and either one can view the objects that are created within it.

# Data Model

Field Type Description
description string User-friendly textual description of the workspace
parties object A list of workspace party IDs corresponding to their records in Bridge's public organization registry

# Example

hide code
{
"description": "Workspace 1",
"parties":
    {
      "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
      "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
    }
}

# API

# List all workspaces

GET /workspaces

# Query parameters

​ Parameter Description Default
limit Maximum number of records to return integer
offset The number of records to skip integer
sort List of comma-separated ordering criteria field:asc|desc

# Create a workspace

POST /workspaces

# Request body:

See data model

# Request example:

hide code
{
"description": "Workspace 1",
"parties":
    {
      "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
      "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
    }
}

# Response example:

hide code
{
    "id": "129cd8bd-6ae9-4614-b97c-74bc79aa93a7",
    "body": {
    "description": "Workspace 1",
    "parties":
        {
          "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
          "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
        }
    }
}

# Get a specific workspace

​ Retrieves the details of an existing workspace. You need only supply the unique workspace identifier that was returned upon workspace creation.

GET /workspaces/{workspace_id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference

# Response example:

hide code
{
    "id": "129cd8bd-6ae9-4614-b97c-74bc79aa93a7",
    "body": {
    "description": "Workspace 1",
    "parties":
        {
          "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
          "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
        }
    }
}

# Update a workspace

​ Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.​

PATCH /workspaces/{workspace_id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference

# Request example:

hide code
{
    "description": "Workspace 1 - Patched"
}

# Response example:

hide code
{
    "id": "129cd8bd-6ae9-4614-b97c-74bc79aa93a7",
    "body": {
    "description": "Workspace 1 - Patched",
    "parties":
        {
          "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
          "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
        }
    }
}

​Parties are not allowed to be updated. Attempting to update workspace parties causes no errors, but produces no changes. ​

# Delete a workspace

​ Permanently deletes a workspace. It cannot be undone.

DELETE /workspaces/{workspace_id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference

# Response example:

hide code
{
    "id": "129cd8bd-6ae9-4614-b97c-74bc79aa93a7",
    "body": {
    "description": "Workspace 1",
    "parties":
        {
          "client": "8d5ad423-bfdd-4b66-a6de-0cde92707f54",
          "vendor": "32c2798a-1aae-4398-b12e-65e99effaaa2"
        }
    }
}

​ A workspace with existing job objects cannot be deleted and returns an error Workspace is not empty. Deleting a workspace with an invalid workspace id returns a 404 error.

Last Updated: 5/11/2021, 6:25:06 PM