Export Cube Aggregates

GET 
/org/:orgId/project/:projectId/cube/:cubeId/aggregates/export

Read a specific Aggregate.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

projectId stringrequired

The Project ID (UUID) for which you are querying.

cubeId stringrequired

The Cube ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

atScaleExportVersion string

The AtScale system version from which the export originated.

exportSummary ConnectionSummaries

Summarized information such as aggregate count, grouped by Connection ID.

exportTimestamp string

Server-generated timestamp the export file was generated.

exportOrgId string

Source Organization

exportProjectId string

Project ID

exportCubeId string

Cube ID. Must exist on the target system.

aggregates AggregateDefinitions

Aggregate Definitions. For internal use only.

Example (from schema)

{
  "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": {}
    }
  ]
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "atScaleExportVersion": "2021.2.0",
    "exportSummary": {
      "connectionIds": {
        "count": 1,
        "values": [
          "con1"
        ]
      }
    },
    "exportTimestamp": "2021-05-04T22:22:32.275Z[UTC]",
    "exportOrgId": "default",
    "exportProjectId": "f7aec09a-7d92-4455-96fe-ccae1b504b28",
    "exportCubeId": "737732be-f50e-47c9-7826-920bfe0a9ef5",
    "aggregates": {
      "count": 1,
      "values": [
        {
          "id": "0fd822f6-0fd5-40bd-9b44-d43927e1a3f2",
          "user_defined_id": null,
          "user_defined_name": null,
          "triggering_query_id": "a0a54009-42f0-4f7c-8313-3cf804d3d4b9",
          "organization_id": "default",
          "environment_id": null,
          "project_id": "f7aec09a-7d92-4455-96fe-ccae1b504b28",
          "plan_json": "//logical plan of the aggregate (JSON)",
          "created_at": "2021-04-21 16:13:18",
          "latest_instance_id": "7c582a7e-23c1-460a-ab39-909370db9de1",
          "base_type": "system_defined",
          "sub_type": "demand_defined",
          "hinted_dataset_id": null,
          "active_instance_id": "7c582a7e-23c1-460a-ab39-909370db9de1",
          "connection_id": "con1",
          "promoted_copy_of": null,
          "promoted": "false",
          "incidental_data": {
            "type": "incidental-data-set",
            "data-set-id": "f79aea6b-f115-4c0a-4c3d-a604c7bc7b23"
          }
        }
      ]
    }
  }
}

400

Bad Request.

401

Unauthorized AtScale user.

403

User does not have permission to access the resource.

500

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

503

This error will occur if Design Center APIs are not enabled.

Loading...