Retrieve Specific Aggregate

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

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.

aggregateId stringrequired

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

Responses

200

Success.

application/json

Schema

Schema

id string
name string
properties CommonProperties
attributes AttributeReferences
partitions PartitionReferences

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": {
    "aggregate": [
      {
        "id": "67d7c22e-dceb-4188-9860-068091697f9b",
        "name": "My Aggregate",
        "properties": {
          "name": "My 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": {}
      }
    ]
  }
}

401

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

404

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

500

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

503

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

Loading...