Import Cube Aggregates
POST/org/:orgId/project/:projectId/cube/:cubeId/aggregates/import
Uploads a file containing the proprietary AtScale Aggregate Definition format for System-Defined aggregates. Use the 'multipart/form-data' Content-Type header. The payload follows the form-data format with the 'file' field populated with the binary-encoded file contents. For example: { file: File_Contents_In_Binary }.
Request
Path Parameters
The Organization ID (UUID) for which you are querying.
The Project ID (UUID) for which you are querying.
The Cube ID (UUID) for which you are querying.
Query Parameters
Whether to import partition hints in aggregate logical plans (defaults to true if unspecified).
Whether to import distribution hints in aggregate logical plans (defaults to true if unspecified).
Whether to import replication hints in aggregate logical plans (defaults to true if unspecified).
originalConnId:newConnId (no remap if unspecified). Pass multiple connection Remap variables to perform muliple remap operations.
- multipart/form-data
Body
required
object
Responses
- 200
- 400
- 401
- 403
- 500
- 503
Success.
- application/json
- Schema
- Example (from schema)
- Example
Schema
The AtScale system version from which the export originated.
Source Organization ID.
Project ID
ID of the Organization to which the file was imported.
ID of the Project to which the file was imported.
ID of the Cube containing the aggregate definitions.
Count of aggregate definitions that were imported.
Count of aggregate definitions that were not imported.
Count: count of the response Values array, Values[ id: Source Aggregate UUID, newID: New Aggregate UUID, Imported: True|False, reason: Human readable reason for Imported=False.]
{
"aggregate": [
{
"id": "67d7c22e-dceb-4188-9860-068091697f9b",
"name": "My Best Aggregate",
"properties": {
"name": "My Best Aggregate",
"notes": "this is an aggregate"
},
"attributes": {
"attribute-ref": [
{
"id": "82c14308-3f56-4244-499d-756e80488e64"
},
{
"id": "cd5089b9-e228-45fa-7507-e74fcf88617d"
},
{
"id": "c0bbeb6f-d74c-45f9-43c7-1e5bb8b4bf62",
"ref-path": {
"ref": [
{
"id": "8e5f2b5c-427c-4796-8424-13ce0963ca5a"
}
]
}
},
{
"id": "9c8cabbe-6510-48ca-9648-8bc376c649b2"
},
{
"id": "3b6b9a46-22d8-4ed9-9c4b-12612dfa3675"
},
{
"id": "b68a0ca1-93ba-4807-8b54-f2d2654ca71c"
}
]
},
"partitions": {}
}
]
}
{
"atScaleExportVersion": "2021.2.0",
"exportOrgId": "default",
"exportProjectId": "f7aec09a-7d92-4455-96fe-ccae1b504b28",
"importOrgId": "myorg",
"importProjectId": "3dcba5b0-b730-4ed8-a0c0-d3cbdaf83a55",
"cubeId": "737732be-f50e-47c9-7826-920bfe0a9ef5",
"numberOfDefinitionsImported": 1,
"numberOfDefinitionsIgnored": 2,
"aggregates": {
"count": 3,
"values": [
{
"id": "0fd822f6-0fd5-40bd-9b44-d43927e1a3f2",
"newId": "4650a657-5d94-4ab5-a547-2e5e18b38a93",
"imported": true
},
{
"id": "15c37c52-84cf-4c20-8a91-2ef87ccffd38",
"imported": false,
"reason": "The connection ID \"con4\" is unknown in Organization \"myorg\"."
},
{
"id": "15c37c52-84cf-4c20-8a91-2ef87ccffd38",
"imported": "false",
"reason": "Aggregate definition already exists: a49f6834-4552-4366-87c7-6237598f15e7"
}
]
}
}
Bad Request.
Unauthorized AtScale user.
User does not have permission to access the resource.
A server error occurred. Check the logs for more details.
This error will occur if Design Center APIs are not enabled.