Move workspace items in bulk

POST /api/v1/deployments/{deploymentId}/workspace/bulk-move

Move workspace items in bulk

cURL

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workspace/bulk-move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "id": 123
    }
  ],
  "folderId": 123
}
'

200

{
  "failed": [
    {
      "error": {
        "message": "<string>",
        "status": 123
      },
      "id": 123
    }
  ],
  "moved": [
    {
      "calculatedFields": {},
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "meta": {},
      "name": "<string>",
      "updatedAt": "2023-12-25",
      "createdBy": 123,
      "dashboardDraft": {
        "app": {
          "entry": "<string>",
          "files": {},
          "html": "<string>",
          "manifest": {
            "dependencies": {},
            "version": 123
          }
        },
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "dashboardPublished": {
        "app": {
          "entry": "<string>",
          "files": {},
          "html": "<string>",
          "manifest": {
            "dependencies": {},
            "version": 123
          }
        },
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "folderId": 123,
      "folderPath": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "isFavorite": true,
      "publishedDashboard": {
        "allowEmbed": true,
        "config": {
          "app": {
            "entry": "<string>",
            "files": {},
            "html": "<string>",
            "manifest": {
              "dependencies": {},
              "version": 123
            }
          },
          "description": "<string>",
          "layout": {
            "breakpoints": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "cols": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "containerPadding": [
              123
            ],
            "margin": [
              123
            ],
            "rowHeight": 123
          },
          "settings": {},
          "theme": {},
          "title": "<string>",
          "widgets": [
            {
              "id": "<string>",
              "position": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "config": {},
              "responsiveLayouts": {
                "lg": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "md": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "sm": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xxs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                }
              },
              "style": {}
            }
          ]
        },
        "deploymentId": 123,
        "id": 123,
        "publicId": "<string>",
        "reportSnapshots": [
          {
            "id": 123,
            "reportId": 123,
            "versionNumber": 123,
            "description": "<string>",
            "fillMissingRows": {
              "member": "<string>",
              "excludedDimensions": [
                "<string>"
              ]
            },
            "meta": {},
            "name": "<string>",
            "periodComparisons": [
              {
                "measure": "<string>",
                "offset": {
                  "amount": 123,
                  "unit": "<string>"
                },
                "timeDimension": "<string>",
                "outputs": [
                  "<string>"
                ]
              }
            ],
            "preferences": {
              "columnFormats": {}
            },
            "spec": "<string>",
            "sqlQuery": "<string>",
            "title": "<string>"
          }
        ],
        "versionId": 123,
        "versionNumber": 123,
        "workbookId": 123,
        "createdBy": 123,
        "description": "<string>",
        "fromSharedWorkspace": true,
        "restrictDataDownload": true,
        "title": "<string>",
        "useBoardDashboards": true
      },
      "slug": "<string>",
      "user": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "userId": 123
    }
  ]
}

Move up to 100 workspace items — workbooks, reports, and folders, mixed freely — into one destination folder in a single request.

Request body:

• items — the items to move, each { type, id } with type one of WORKBOOK, REPORT, FOLDER. Repeated references to the same item are collapsed, so the response holds exactly one entry per distinct item requested.
• folderId — the destination folder id for the whole batch, or null to move the items to the workspace root. For a folder item this becomes its new parent.

This endpoint is partially successful. It returns 200 whenever the request itself is well formed, and reports each item’s outcome separately:

• moved — the items that were moved, serialized exactly as POST /workspace/move returns them.
• failed — the items that were not moved, each with the (type, id) requested and an error carrying the status and message the single-item move would have returned for it (403 when the caller lacks access, 404 when the item does not exist or belongs to another deployment, 400 for an invalid move such as a folder into its own descendant).

An empty failed array means the whole batch applied. Items are applied one at a time in the order given, each in its own transaction, so earlier moves are not rolled back when a later item fails — the response is the record of what was applied.

Access is checked per item with the same rules as the single-item move, so a batch mixing items the caller may and may not move applies the permitted ones and reports the rest.

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId · number · required

Body

application/json

BulkMoveWorkspaceObjectsInput

items · object[] · required

Required array length: 1 - 100 elements

Show child attributes

folderId · integer | null

Response

200 - application/json

failed · object[] · required

Show child attributes

moved · object[] · required

Show child attributes