GET /reflection/{id}

Retrieves a specific reflection.
Only users with administrator privileges can use the reflections API.

See Reflection for details on object representations.

Syntax

GET /api/v3/reflection/{id}

Response Output

{
  "data": [
    reflection,
    ...
  ]
}

JSON representation of a reflection
See Reflection for more information.

{
  "entityType": "reflection" [immutable, generated by Dremio],
  "id": String [immutable, generated by Dremio],
  "tag": String [immutable, generated by Dremio],
  "name": String,
  "enabled": Boolean,
  "createdAt": String (RFC3339 date) [immutable, generated by Dremio],
  "updatedAt": String (RFC3339 date) [immutable, generated by Dremio],
  "type": String ["AGGREGATION", "RAW"] [immutable after creation],
  "datasetId": String [immutable after creation],
  "currentSizeBytes": Number [immutable, generated by Dremio],
  "totalSizeBytes": Number [immutable, generated by Dremio],
  "status": Reflection Status [immutable, generated by Dremio],
  "dimensionFields": [Reflection Field With Granularity] [optional, only valid for AGGREGATION],
  "measureFields": [Reflection Field] [optional, only valid for AGGREGATION],
  "displayFields": [Reflection Field] [optional, only valid for RAW],
  "distributionFields": [Reflection Field] [optional],
  "partitionFields": [Reflection Field] [optional],
  "sortFields": [Reflection Field] [optional],
  "partitionDistributionStrategy": String ["CONSOLIDATED", "STRIPED"],
}

Response Codes

403 - user does not have permission to list or view reflections (has to be an administrator).
404 - a reflection with the specified id could not be found.


results matching ""

    No results matching ""