extensions.pbi.extension.cdm.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of objectmodel Show documentation
CDM SDK to work with semantic metadata of the Data
There is a newer version: 100.0.7
{
  "jsonSchemaSemanticVersion": "1.0.0",
  "imports": [
    {
      "corpusPath": "/extensions/base.extension.cdm.json"
    }
  ],
  "definitions": [
    {
      "traitName": "is.extension.pbi:dataCategory",
      "extendsTrait": "is.extension",
      "explanation": "The Power BI data category for the entity or attribute this property is added for.",
      "hasParameters": [
        {
          "name": "is.extension.pbi:dataCategory",
          "dataType": "string",
          "explanation": "Default parameter since extension isn't an object."
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:mashup",
      "explanation": "The mashup query and properties for the current document.",
      "extendsTrait": "is.extension",
      "hasParameters": [
        {
          "name": "fastCombine",
          "dataType": "boolean",
          "defaultValue": true,
          "explanation": "The fastCombine for the mashup query."
        },
        {
          "name": "allowNativeQueries",
          "dataType": "boolean",
          "defaultValue": false,
          "explanation": "Set if native queries are allowed."
        },
        {
          "name": "document",
          "dataType": "string",
          "explanation": "The mashup query for the current document."
        },
        {
          "name": "queriesMetadata",
          "dataType": "object",
          "explanation": "Dictionary of query name to it's metadata containing query id, name, entity name etc."
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:refreshPolicy",
      "explanation": "The refresh policy for the entity. Full Refresh and Incremental Refresh are potential examples from Power BI.",
      "extendsTrait": "is.extension",
      "hasParameters": [
        {
          "name": "$type",
          "explanation": "The type of the refresh policy.",
          "dataType": "string"
        },
        {
          "name": "location",
          "explanation": "The root location to use for refresh.",
          "dataType": "string"
        },
        {
          "name": "rollingWindowGranularity",
          "dataType": "string",
          "explanation": "The granularity of the rolling window for the incremental refresh. it can be day, month, quarter or year.",
          "defaultValue": "Invalid"
        },
        {
          "name": "incrementalGranularity",
          "dataType": "string",
          "explanation": "The granularity of the incremental period in the window. it can be day, month, quarter or year.",
          "defaultValue": "Invalid"
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:partitionDataQuery",
      "extendsTrait": "is.extension",
      "explanation": "Stores the partition query.",
      "hasParameters": [
        {
          "name": "is.extension.pbi:partitionDataQuery",
          "dataType": "string"
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:refreshBookmark",
      "explanation": "The refresh bookmark for the last refresh of the partition.",
      "extendsTrait": "is.extension",
      "hasParameters": [
        {
          "name": "is.extension.pbi:refreshBookmark",
          "dataType": "string"
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:source",
      "explanation": "The source for the partition.",
      "extendsTrait": "is.extension",
      "hasParameters": [
        {
          "name": "$type",
          "explanation": "The type of source of the partition.",
          "dataType": "string"
        },
        {
          "name": "start",
          "explanation": "The start date time for the ranged partition.",
          "dataType": "string"
        },
        {
          "name": "end",
          "explanation": "The end date time for the ranged partition.",
          "dataType": "string"
        }
      ]
    },
    {
      "traitName": "is.extension.pbi:timezone",
      "explanation": "The timezone for which the times specified in the document are valid.",
      "extendsTrait": "is.extension",
      "hasParameters": [
        {
          "name": "is.extension.pbi:timezone",
          "dataType": "string",
          "default value": "Greenwich Mean Time"
        }
      ]
    }
  ]
}