Copy Existing Cube

POST 
/org/:orgId/project/:projectId/cube/:cubeId/copy

Copy an existing Cube by specifying its ID, and the corresponding Organization ID and Project ID.

Request

Path Parameters

orgId stringrequired

The Organization ID of the cube you want to copy

projectId stringrequired

The Project ID of the cube you want to copy

cubeId stringrequired

ID of the cube you want to copy

Query Parameters

name stringrequired

Name for the copied cube

description stringrequired

Description for the copied cube

inclusive-access stringrequired

true / false

copy-security booleanrequired

true / false

application/json

Body

required

any

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "fa7e1978-2333-4eda-5d15-c22059cb98e6",
    "name": "My new cube - copy",
    "properties": {
      "description": "Copy of My new cube, to be used for testing",
      "caption": "My new cube - copy",
      "visible": true
    },
    "attributes": {},
    "dimensions": {},
    "actions": {
      "properties": {
        "include-default-drill-through": true
      }
    },
    "data-sets": {
      "data-set-ref": [
        {
          "uiid": "ca79f3c4-b16d-4aa6-67e6-5c12ef3117ed",
          "id": "bd58eed7-ef4f-416f-6d06-0ee463263072",
          "properties": {
            "allow-aggregates": true,
            "create-hinted-aggregate": false,
            "aggregate-destinations": null
          },
          "logical": {
            "key-ref": [
              {
                "id": "1f63a7d7-b86d-4965-96b3-b4d998726a73",
                "unique": false,
                "complete": "false",
                "column": [
                  "customerkey"
                ]
              }
            ]
          }
        }
      ]
    },
    "calculated-members": {},
    "aggregates": {}
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "fa7e1978-2333-4eda-5d15-c22059cb98e6",
    "name": "My new cube - copy",
    "properties": {
      "description": "Copy of My new cube, to be used for testing",
      "caption": "My new cube - copy",
      "visible": true
    },
    "attributes": {},
    "dimensions": {},
    "actions": {
      "properties": {
        "include-default-drill-through": true
      }
    },
    "data-sets": {
      "data-set-ref": [
        {
          "uiid": "ca79f3c4-b16d-4aa6-67e6-5c12ef3117ed",
          "id": "bd58eed7-ef4f-416f-6d06-0ee463263072",
          "properties": {
            "allow-aggregates": true,
            "create-hinted-aggregate": false,
            "aggregate-destinations": null
          },
          "logical": {
            "key-ref": [
              {
                "id": "1f63a7d7-b86d-4965-96b3-b4d998726a73",
                "unique": false,
                "complete": "false",
                "column": [
                  "customerkey"
                ]
              }
            ]
          }
        }
      ]
    },
    "calculated-members": {},
    "aggregates": {}
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...