Power BI data contract | PatchOps Knowledge

Provenance

PublisherPower BI

API basehttps://api.powerbi.com/v1.0/myorg

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (OAuth)

Methods (44)

listWorkspaces

read

List accessible workspaces. Returns id, name, isOnDedicatedCapacity (Premium), capacityId.

Input schema

{
  "type": "object",
  "properties": {
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

listDashboards

read

List dashboards. Pass workspaceId to scope to a workspace, or omit for "My Workspace".

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getDashboardTiles

read

Get tiles pinned to a dashboard. Discovers source datasets/reports before DAX queries.

Required paramsdashboardId

Input schema

{
  "type": "object",
  "properties": {
    "dashboardId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "dashboardId"
  ]
}

listReports

read

List reports. Pass workspaceId for a specific workspace, omit for "My Workspace".

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getReportPages

read

List the pages of a report. Useful for embed-token generation and navigation.

Required paramsreportId

Input schema

{
  "type": "object",
  "properties": {
    "reportId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "reportId"
  ]
}

listDatasets

read

List datasets. workspaceId scopes to workspace; omit for "My Workspace". Shows isRefreshable.

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getDataset

read

Get details on a single dataset by id.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

refreshDataset

write

Trigger async dataset refresh. Returns immediately; check via getDatasetRefreshHistory.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "notifyOption": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "NoNotification"
          ]
        },
        {
          "type": "string",
          "enum": [
            "MailOnFailure"
          ]
        },
        {
          "type": "string",
          "enum": [
            "MailOnCompletion"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

getDatasetRefreshHistory

read

Get the recent refresh history for a dataset, including status and timing.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

executeDaxQuery

read

Run DAX queries against a dataset. Cap 100k rows/1M values — use TOPN/FILTER/SUMMARIZECOLUMNS.

Required paramsdatasetIdqueries

Entitiesdataset

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "queries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string"
          }
        },
        "required": [
          "query"
        ],
        "additionalProperties": false
      }
    },
    "impersonatedUserName": {
      "type": "string"
    },
    "includeNulls": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "queries"
  ]
}

runDax

read

Run a single DAX query, return rows of first result. Same caps as executeDaxQuery.

Required paramsdatasetIdquery

Entitiesdataset

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "query": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "query"
  ]
}

getPowerBICapabilities

read

Whether user has Premium capacity access (cached 15 min). Build methods use internally.

Input schema

{
  "type": "object",
  "properties": {
    "forceRefresh": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

createPushDataset

write

Create push dataset with schema. No measures/relationships — use uploadPbixOrTemplate.

Required paramsspec

Input schema

{
  "type": "object",
  "properties": {
    "spec": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "tables": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "columns": {
                "type": "array",
                "items": {}
              }
            },
            "required": [
              "name",
              "columns"
            ],
            "additionalProperties": false
          }
        },
        "defaultMode": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "Push"
              ]
            },
            {
              "type": "string",
              "enum": [
                "PushStreaming"
              ]
            },
            {
              "type": "string",
              "enum": [
                "Streaming"
              ]
            }
          ]
        }
      },
      "required": [
        "name",
        "tables"
      ],
      "additionalProperties": false
    },
    "workspaceId": {
      "type": "string"
    },
    "defaultRetentionPolicy": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "None"
          ]
        },
        {
          "type": "string",
          "enum": [
            "basicFIFO"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "spec"
  ]
}

pushRowsToTable

unknown

Push rows into a table. Cap: 10k rows/request, 1M rows/hour per dataset. Batch larger loads.

Required paramsdatasetIdtableNamerows

Entitiestable

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "tableName": {
      "type": "string"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "tableName",
    "rows"
  ]
}

clearRowsInTable

unknown

Truncate all rows from a push-dataset table. Useful before a full refresh push.

Required paramsdatasetIdtableName

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "tableName": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "tableName"
  ]
}

updateTableSchema

write

Update a push-dataset table schema (add/rename columns). Existing rows are preserved if compatible.

Required paramsdatasetIdtableNamecolumns

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "tableName": {
      "type": "string"
    },
    "columns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "dataType": {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "string"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "Int64"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "Double"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "Boolean"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "DateTime"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "Decimal"
                ]
              }
            ]
          }
        },
        "required": [
          "name",
          "dataType"
        ],
        "additionalProperties": false
      }
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "tableName",
    "columns"
  ]
}

createDashboard

write

Create empty dashboard (returns id, embedUrl). Pin tiles via cloneTile or report visuals.

Required paramsname

Input schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

cloneTile

unknown

Clone tile across dashboards. Optional rebind to different report/dataset.

Required paramssourceDashboardIdsourceTileIdtargetDashboardId

Entitiestile

Input schema

{
  "type": "object",
  "properties": {
    "sourceDashboardId": {
      "type": "string"
    },
    "sourceTileId": {
      "type": "string"
    },
    "targetDashboardId": {
      "type": "string"
    },
    "sourceWorkspaceId": {
      "type": "string"
    },
    "targetWorkspaceId": {
      "type": "string"
    },
    "targetReportId": {
      "type": "string"
    },
    "targetModelId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "sourceDashboardId",
    "sourceTileId",
    "targetDashboardId"
  ]
}

uploadPbixOrTemplate

write

Upload PBIX/PBIT as dataset+report. Highest-fidelity build path.

Required paramsdisplayNamefileContent

Input schema

{
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string"
    },
    "fileContent": {
      "type": "string"
    },
    "fileType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pbix"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pbit"
          ]
        }
      ]
    },
    "workspaceId": {
      "type": "string"
    },
    "nameConflict": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Abort"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Overwrite"
          ]
        },
        {
          "type": "string",
          "enum": [
            "CreateOrOverwrite"
          ]
        },
        {
          "type": "string",
          "enum": [
            "GenerateUniqueName"
          ]
        }
      ]
    },
    "overrideReportLabel": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "displayName",
    "fileContent"
  ]
}

fileContent=base64. fileType "pbix"|"pbit". nameConflict: Abort|Overwrite.

getImportStatus

write

Check upload status from uploadPbixOrTemplate. importState="Succeeded" when ready.

Required paramsimportId

Input schema

{
  "type": "object",
  "properties": {
    "importId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "importId"
  ]
}

setDatasetParameters

write

Update dataset parameter values. Call refreshDataset after to apply.

Required paramsdatasetIdparameters

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "newValue": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "newValue"
        ],
        "additionalProperties": false
      }
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "parameters"
  ]
}

getDatasetParameters

read

Get current parameter values on a dataset. Use before setDatasetParameters.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

generateReportEmbedToken

unknown

Embed token for a report. Combine with embedUrl. accessLevel View|Edit|Create.

Required paramsreportId

Entitiestoken

Input schema

{
  "type": "object",
  "properties": {
    "accessLevel": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "View"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Edit"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Create"
          ]
        }
      ]
    },
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "datasets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "username",
          "roles",
          "datasets"
        ],
        "additionalProperties": false
      }
    },
    "lifetimeInMinutes": {
      "type": "number"
    },
    "reportId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "datasetId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "reportId"
  ]
}

RLS via identities[]. TTL 60 min max.

generateDashboardEmbedToken

unknown

Embed token for a dashboard. Same options as generateReportEmbedToken.

Required paramsdashboardId

Entitiestoken

Input schema

{
  "type": "object",
  "properties": {
    "accessLevel": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "View"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Edit"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Create"
          ]
        }
      ]
    },
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "datasets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "username",
          "roles",
          "datasets"
        ],
        "additionalProperties": false
      }
    },
    "lifetimeInMinutes": {
      "type": "number"
    },
    "dashboardId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "dashboardId"
  ]
}

generateTileEmbedToken

unknown

Embed token for a single dashboard tile (single chart vs whole dashboard).

Required paramsdashboardIdtileId

Entitiestoken

Input schema

{
  "type": "object",
  "properties": {
    "accessLevel": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "View"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Edit"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Create"
          ]
        }
      ]
    },
    "identities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "datasets": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "username",
          "roles",
          "datasets"
        ],
        "additionalProperties": false
      }
    },
    "lifetimeInMinutes": {
      "type": "number"
    },
    "dashboardId": {
      "type": "string"
    },
    "tileId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "dashboardId",
    "tileId"
  ]
}

getRefreshSchedule

read

Get the scheduled refresh configuration for a dataset (days, times, timezone, enabled flag).

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

updateRefreshSchedule

write

Update refresh schedule. enabled=false disables; days+times+localTimeZoneId enables.

Required paramsdatasetIdschedule

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "schedule": {
      "type": "object",
      "properties": {
        "days": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "times": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enabled": {
          "type": "boolean"
        },
        "localTimeZoneId": {
          "type": "string"
        },
        "notifyOption": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "NoNotification"
              ]
            },
            {
              "type": "string",
              "enum": [
                "MailOnFailure"
              ]
            },
            {
              "type": "string",
              "enum": [
                "MailOnCompletion"
              ]
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "schedule"
  ]
}

TZ: Windows ids. notifyOption: NoNotification|MailOnFailure|MailOnCompletion.

getDirectQueryRefreshSchedule

read

Get DirectQuery refresh schedule (Premium, separate from regular).

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

getDatasources

read

List dataset datasources + gateway binding. Required before bindToGateway/updateDatasource.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

listGateways
read
List on-premises data gateways the user can use. Required before binding a dataset to a gateway.
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

discoverGateways

read

Find gateways with datasources matching the dataset. Pick gatewayObjectId for bindToGateway.

Required paramsdatasetId

Entitiesgateway

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

bindToGateway

unknown

Bind dataset to a gateway. Datasources must exist; call discoverGateways first.

Required paramsdatasetIdgatewayObjectId

Entitiesgateway, dataset

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "gatewayObjectId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "datasourceObjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "gatewayObjectId"
  ]
}

updateDatasource

write

Update dataset datasource connection strings via updateDetails entries.

Required paramsdatasetIdupdateDetails

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    },
    "updateDetails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "datasourceSelector": {
            "type": "object",
            "properties": {
              "datasourceType": {
                "type": "string"
              },
              "connectionDetails": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            },
            "required": [
              "datasourceType",
              "connectionDetails"
            ],
            "additionalProperties": false
          },
          "datasourceName": {
            "type": "string"
          },
          "connectionDetails": {
            "type": "object",
            "properties": {},
            "additionalProperties": true
          }
        },
        "required": [
          "connectionDetails"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "updateDetails"
  ]
}

updateDatasourceCredentials

write

Rotate datasource credentials on a gateway without re-binding.

Required paramsgatewayIddatasourceIdcredentialDetails

Input schema

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string"
    },
    "datasourceId": {
      "type": "string"
    },
    "credentialDetails": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "gatewayId",
    "datasourceId",
    "credentialDetails"
  ]
}

takeOverDataset

unknown

Claim dataset ownership. Required after imports/migrations before updating datasources.

Required paramsdatasetId

Entitiesdataset

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

createStreamingDataset

write

Create streaming dataset. mode: "Streaming" (live only) or "PushStreaming" (live + history).

Required paramsspec

Input schema

{
  "type": "object",
  "properties": {
    "spec": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "tables": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "columns": {
                "type": "array",
                "items": {}
              }
            },
            "required": [
              "name",
              "columns"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "name",
        "tables"
      ],
      "additionalProperties": false
    },
    "mode": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "PushStreaming"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Streaming"
          ]
        }
      ]
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "spec"
  ]
}

postRowsToStreamingTable

write

Push rows to streaming table. Goes to ring buffer for live tile rendering.

Required paramsdatasetIdtableNamerows

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "tableName": {
      "type": "string"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId",
    "tableName",
    "rows"
  ]
}

deleteDataset

write

Delete a dataset. DESTRUCTIVE — removes tiles/reports built on it. Confirm first.

Required paramsdatasetId

Input schema

{
  "type": "object",
  "properties": {
    "datasetId": {
      "type": "string"
    },
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "datasetId"
  ]
}

createWorkspace

write

Create a workspace (caller becomes Admin). workspaceV2:true = modern Premium-aware type.

Required paramsname

Input schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "workspaceV2": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

updateWorkspace

write

Update workspace properties (rename, update description). Caller must be a workspace Admin.

Required paramsworkspaceId

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "workspaceId"
  ]
}

deleteWorkspace

write

Delete workspace. DESTRUCTIVE — removes all dashboards/reports/datasets. Admin only.

Required paramsworkspaceId

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "workspaceId"
  ]
}

listWorkspaceUsers

read

List members of a workspace and their access rights.

Required paramsworkspaceId

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "workspaceId"
  ]
}

addWorkspaceUser

write

Add user/group/SP to workspace.

Required paramsworkspaceIdidentifiergroupUserAccessRight

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "identifier": {
      "type": "string"
    },
    "groupUserAccessRight": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "Admin"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Member"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Contributor"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Viewer"
          ]
        }
      ]
    },
    "principalType": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "User"
          ]
        },
        {
          "type": "string",
          "enum": [
            "Group"
          ]
        },
        {
          "type": "string",
          "enum": [
            "App"
          ]
        }
      ]
    },
    "displayName": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "workspaceId",
    "identifier",
    "groupUserAccessRight"
  ]
}

removeWorkspaceUser

write

Remove user from workspace. userIdOrEmail = email (users) or objectId (groups/SPs).

Required paramsworkspaceIduserIdOrEmail

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "userIdOrEmail": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "workspaceId",
    "userIdOrEmail"
  ]
}

Power BI

Provenance

Freshness & coverage

Methods (44)

listWorkspaces

listDashboards

getDashboardTiles

listReports

getReportPages

listDatasets

getDataset

refreshDataset

getDatasetRefreshHistory

executeDaxQuery

runDax

getPowerBICapabilities

createPushDataset

pushRowsToTable

clearRowsInTable

updateTableSchema

createDashboard

cloneTile

uploadPbixOrTemplate

getImportStatus

setDatasetParameters

getDatasetParameters

generateReportEmbedToken

generateDashboardEmbedToken

generateTileEmbedToken

getRefreshSchedule

updateRefreshSchedule

getDirectQueryRefreshSchedule

getDatasources

listGateways

discoverGateways

bindToGateway

updateDatasource

updateDatasourceCredentials

takeOverDataset

createStreamingDataset

postRowsToStreamingTable

deleteDataset

createWorkspace

updateWorkspace

deleteWorkspace

listWorkspaceUsers

addWorkspaceUser

removeWorkspaceUser