On this page

    Create a Reflection

    This API creates a new reflection.

    See “Reflection and Reflection-Summary Objects” for the structure and descriptions of the fields of reflection objects.

    Syntax

    POST /api/v3/reflection
    

    Request Input

    The request body must include a partial reflection object that includes these fields:

    {
        "type": String ["AGGREGATION", "RAW"],
        "name": String,
        "datasetId": String,
        "enabled": Boolean,
        "arrowCachingEnabled": Boolean,
        "displayFields": [List of one or more fields] [valid only for reflections of type RAW],
        "dimensionFields": [List of one or more fields, including their granularity] [valid only for reflections of type AGGREGATION],
        "measureFields": [List of one or more measure fields, including their types] [valid only for reflections of type AGGREGATION],
        "distributionFields": [List of one or more fields] [optional],
        "partitionFields": [List of one or more fields] [optional],
        "sortFields": [List of one or more fields] [optional],
        "partitionDistributionStrategy": String ["CONSOLIDATED", "STRIPED"],
        "entityType": "reflection"
    }
    

    Response Output

    Dremio returns a complete reflection object.

    reflection
    

    Response Codes

    400 - invalid configuration provided.
    403 - user does not have permission to create a reflection (has to be an administrator).