---
title: "Patch Workspace entity"
method: PATCH
path: "/api/v1/entities/workspaces/{id}"
tags: ["Workspaces - Entity APIs"]
---

# Patch Workspace entity

`PATCH /api/v1/entities/workspaces/{id}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/workspaces/{id}`
- Auth: none declared

Space of the shared interest

## Path parameters

- `id` string, required

## Query parameters

- `filter` string
- `include` string[]

## Request body

- JsonApiWorkspacePatchDocument
  - `data` JsonApiWorkspacePatch, required: JSON:API representation of patching workspace entity.
    - `attributes` object
      - `cacheExtraLimit` integer
      - `dataSource` object: The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
        - `id` string, required: The ID of the used data source.
        - `schemaPath` string[]: The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
      - `description` string, nullable
      - `earlyAccess` string, nullable: The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
      - `earlyAccessValues` string[], nullable: The early access feature identifiers. They are used to enable experimental features.
      - `name` string, nullable
      - `prefix` string, nullable: Custom prefix of entity identifiers in workspace
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `parent` object
        - `data` JsonApiWorkspaceToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'workspace', required
    - `type` 'workspace', required: Object type

## Response `200`

Request successfully processed

- JsonApiWorkspaceOutDocument
  - `data` JsonApiWorkspaceOut, required: JSON:API representation of workspace entity.
    - `attributes` object
      - `cacheExtraLimit` integer
      - `dataSource` object: The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
        - `id` string, required: The ID of the used data source.
        - `schemaPath` string[]: The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
      - `description` string, nullable
      - `earlyAccess` string, nullable: The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
      - `earlyAccessValues` string[], nullable: The early access feature identifiers. They are used to enable experimental features.
      - `managed` boolean: Whether the object is platform-managed and read-only.
      - `name` string, nullable
      - `prefix` string, nullable: Custom prefix of entity identifiers in workspace
    - `id` string, required: API identifier of an object
    - `meta` object
      - `config` object
        - `approximateCountAvailable` boolean: is approximate count enabled - based on type of data-source connected to this workspace
        - `dataSamplingAvailable` boolean: is sampling enabled - based on type of data-source connected to this workspace
        - `showAllValuesOnDatesAvailable` boolean: is 'show all values' displayed for dates - based on type of data-source connected to this workspace
      - `dataModel` object
        - `datasetCount` integer, required: include the number of dataset of each workspace
      - `hierarchy` object
        - `childrenCount` integer, required: include the number of direct children of each workspace
      - `permissions` string[]: List of valid permissions for a logged-in user.
    - `relationships` object
      - `parent` object
        - `data` JsonApiWorkspaceToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'workspace', required
    - `type` 'workspace', required: Object type
  - `included` JsonApiWorkspaceOutWithLinks[]: Included resources
    - `attributes` object
      - `cacheExtraLimit` integer
      - `dataSource` object: The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
        - `id` string, required: The ID of the used data source.
        - `schemaPath` string[]: The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
      - `description` string, nullable
      - `earlyAccess` string, nullable: The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
      - `earlyAccessValues` string[], nullable: The early access feature identifiers. They are used to enable experimental features.
      - `managed` boolean: Whether the object is platform-managed and read-only.
      - `name` string, nullable
      - `prefix` string, nullable: Custom prefix of entity identifiers in workspace
    - `id` string, required: API identifier of an object
    - `meta` object
      - `config` object
        - `approximateCountAvailable` boolean: is approximate count enabled - based on type of data-source connected to this workspace
        - `dataSamplingAvailable` boolean: is sampling enabled - based on type of data-source connected to this workspace
        - `showAllValuesOnDatesAvailable` boolean: is 'show all values' displayed for dates - based on type of data-source connected to this workspace
      - `dataModel` object
        - `datasetCount` integer, required: include the number of dataset of each workspace
      - `hierarchy` object
        - `childrenCount` integer, required: include the number of direct children of each workspace
      - `permissions` string[]: List of valid permissions for a logged-in user.
    - `relationships` object
      - `parent` object
        - `data` JsonApiWorkspaceToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'workspace', required
    - `type` 'workspace', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.
  - `meta` object
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)