Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
13740 lines (13602 sloc) 602 KB
{
"swagger": "2.0",
"info": {
"version": "v1.0",
"title": "Power BI Client"
},
"host": "api.powerbi.com",
"schemes": [
"https"
],
"consumes": [
],
"produces": [
],
"paths": {
"/v1.0/myorg/datasets": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of datasets from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDatasets",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Datasets"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"addRowsAPIEnabled": false,
"configuredBy": "john@contoso.com",
"isRefreshable": true,
"isEffectiveIdentityRequired": false,
"isEffectiveIdentityRolesRequired": false,
"isOnPremGatewayRequired": false
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"PushDatasets"
],
"summary": "Creates a new dataset on **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_PostDataset",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dataset",
"in": "body",
"description": "Dataset defenition to create",
"required": true,
"schema": {
"$ref": "#/definitions/CreateDatasetRequest"
}
},
{
"name": "defaultRetentionPolicy",
"description": "The default retention policy",
"in": "query",
"required": false,
"type": "string",
"enum": [
"None",
"basicFIFO"
],
"x-ms-enum": {
"name": "DefaultRetentionPolicy",
"modelAsExtensible": true,
"values": [
{
"value": "None",
"description": "None"
},
{
"value": "basicFIFO",
"description": "basicFIFO"
}
]
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Dataset"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/Dataset"
}
}
},
"x-ms-examples": {
"Push example": {
"parameters": {
"defaultRetentionPolicy": "basicFIFO",
"dataset": {
"name": "SalesMarketing",
"defaultMode": "Push",
"tables": [
{
"name": "Product",
"columns": [
{
"name": "ProductID",
"dataType": "Int64"
},
{
"name": "Name",
"dataType": "string"
},
{
"name": "Category",
"dataType": "string"
},
{
"name": "IsCompete",
"dataType": "bool"
},
{
"name": "ManufacturedOn",
"dataType": "DateTime"
}
]
}
]
}
},
"responses": {
"201": {
"body": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"defaultRetentionPolicy": "basicFIFO"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDataset",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dataset"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"addRowsAPIEnabled": false,
"configuredBy": "john@contoso.com",
"isRefreshable": true,
"isEffectiveIdentityRequired": true,
"isEffectiveIdentityRolesRequired": true,
"isOnPremGatewayRequired": false
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Datasets"
],
"summary": "Deletes the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_DeleteDataset",
"consumes": [
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/tables": {
"get": {
"tags": [
"PushDatasets"
],
"summary": "Returns a list of tables tables within the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetTables",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tables"
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/tables/{tableName}": {
"put": {
"tags": [
"PushDatasets"
],
"summary": "Updates the metadata and schema for the specified table within the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_PutTable",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"description": "The dataset id",
"required": true,
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The table name",
"required": true,
"type": "string"
},
{
"name": "requestMessage",
"in": "body",
"description": "Table name and columns to update existing table",
"required": true,
"schema": {
"$ref": "#/definitions/Table"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Table"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"tableName": "Product",
"requestMessage": {
"tableName": "NewProduct",
"columns": [
{
"name": "ProductID",
"dataType": "Int64"
},
{
"name": "Name",
"dataType": "string"
},
{
"name": "Category",
"dataType": "string"
},
{
"name": "IsCompete",
"dataType": "bool"
},
{
"name": "ManufacturedOn",
"dataType": "DateTime"
},
{
"name": "NewColumn",
"dataType": "string"
}
]
}
},
"responses": {
"200": {
"body": {
"name": "NewProduct"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/tables/{tableName}/rows": {
"post": {
"tags": [
"PushDatasets"
],
"summary": "Adds new data rows to the specified table within the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**REST API Limitations:** See [Power BI REST API limitations](https://msdn.microsoft.com/library/dn950053.aspx). <br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_PostRows",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"required": true,
"description": "The dataset id",
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The table name",
"required": true,
"type": "string"
},
{
"name": "requestMessage",
"in": "body",
"description": "The request message",
"required": true,
"schema": {
"$ref": "#/definitions/PostRowsRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"tableName": "Product",
"requestMessage": {
"rows": [
{
"ProductID": 1,
"Name": "Adjustable Race",
"Category": "Components",
"IsCompete": true,
"ManufacturedOn": "07/30/2014"
},
{
"ProductID": 2,
"Name": "LL Crankarm",
"Category": "Components",
"IsCompete": true,
"ManufacturedOn": "07/30/2014"
},
{
"ProductID": 3,
"Name": "HL Mountain Frame - Silver",
"Category": "Bikes",
"IsCompete": true,
"ManufacturedOn": "07/30/2014"
}
]
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"PushDatasets"
],
"summary": "Deletes all rows from the specified table within the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**: this API supports only Push datasets. <br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_DeleteRows",
"consumes": [
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"description": "The dataset id",
"required": true,
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The table name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"tableName": "Product"
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/refreshes": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns the refresh history of the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetRefreshHistory",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "$top",
"description": "The requested number of entries in the refresh history. If not provided, the default is all available entries.",
"in": "query",
"required": false,
"type": "integer",
"minimum": 1
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Refreshes"
}
}
},
"x-ms-examples": {
"in progress refresh example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"$top": 1
},
"responses": {
"200": {
"body": {
"value": [
{
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"status": "Unknown",
"requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
}
]
}
}
}
},
"completed refresh example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"$top": 1
},
"responses": {
"200": {
"body": {
"value": [
{
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-13T09:31:43.153Z",
"status": "Completed",
"requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
}
]
}
}
}
},
"Failed refresh example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"$top": 1
},
"responses": {
"200": {
"body": {
"value": [
{
"refreshType": "ViaApi",
"startTime": "2017-06-13T09:25:43.153Z",
"endTime": "2017-06-13T09:31:43.153Z",
"serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
"status": "Failed",
"requestId": "11bf290a-346b-48b7-8973-c5df149337ff"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Datasets"
],
"summary": "Triggers a refresh for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh)<br/>In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh will fail.<br/><br/>**Required scope**: Dataset.ReadWrite.All<br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_RefreshDataset",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "refreshRequest",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/RefreshRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"refreshRequest": {
"notifyOption": "MailOnFailure"
}
},
"responses": {
"202": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/refreshSchedule": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns the refresh schedule of the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetRefreshSchedule",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RefreshSchedule"
}
}
},
"x-ms-examples": {
"Refresh Schedule example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"days": [ "Sunday", "Friday", "Saturday" ],
"times": [ "05:00", "11:30", "17:30", "23:00" ],
"enabled": true,
"localTimeZoneId": "UTC",
"notifyOption": "MailOnFailure"
}
}
}
}
},
"deprecated": false
},
"patch": {
"tags": [
"Datasets"
],
"summary": "Updates the refresh schedule for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>This operation is only supported for the dataset owner.<br/>A request that disables the refresh schedule should contain no other changes.<br/>The days array should not be set to empty array.<br/>The times may be set to empty array (in which case Power BI will use a default single time per day).<br/>The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see [What is Microsoft Power BI Premium](https://docs.microsoft.com/en-us/power-bi/service-premium).<br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_UpdateRefreshSchedule",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "datasetModelRefreshScheduleRequest",
"description": "Update Refresh Schedule parameters, by specifying all or some of the parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RefreshScheduleRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"change notification option": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetModelRefreshScheduleRequest": {
"value": {
"notifyOption": "NoNotification"
}
}
},
"responses": {
"200": {}
}
},
"change days and times": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetModelRefreshScheduleRequest": {
"value": {
"days": [ "Sunday", "Tuesday", "Friday", "Saturday" ],
"times": [ "07:00", "11:30", "16:00", "23:30" ],
"localTimeZoneId": "UTC"
}
}
},
"responses": {
"200": {}
}
},
"update times": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetModelRefreshScheduleRequest": {
"value": {
"times": [ "08:00", "16:00" ]
}
}
},
"responses": {
"200": {}
}
},
"disable scheduled refresh": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetModelRefreshScheduleRequest": {
"value": {
"enabled": false
}
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/directQueryRefreshSchedule": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDirectQueryRefreshSchedule",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DirectQueryRefreshSchedule"
}
}
},
"x-ms-examples": {
"By Days Schedule example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"days": [ "Sunday", "Friday", "Saturday" ],
"times": [ "05:00", "11:30", "17:30", "23:00" ],
"localTimeZoneId": "UTC"
}
}
}
},
"By Frequency Schedule example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"frequency": 15,
"days": [],
"times": [],
"localTimeZoneId": "UTC"
}
}
}
}
},
"deprecated": false
},
"patch": {
"tags": [
"Datasets"
],
"summary": "Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from **\"My Workspace\"**.",
"description": "<br/>This operation is only supported for the dataset owner.<br/>A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both.<br/>Setting frequency will automatically truncate the days and times arrays.<br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_UpdateDirectQueryRefreshSchedule",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "datasetDQRefreshScheduleRequest",
"description": "Patch DirectQuery or LiveConnection Refresh Schedule parameters, by specifying all or some of the parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DirectQueryRefreshScheduleRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"change to frequency based schedule": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetDQRefreshScheduleRequest": {
"value": {
"frequency": 30
}
}
},
"responses": {
"200": {}
}
},
"switch to days and times based schedule": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetDQRefreshScheduleRequest": {
"value": {
"days": [ "Sunday", "Tuesday", "Friday", "Saturday" ],
"times": [ "07:00", "11:30", "16:00", "23:30" ],
"localTimeZoneId": "UTC"
}
}
},
"responses": {
"200": {}
}
},
"update the times of existing days based schedule": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetDQRefreshScheduleRequest": {
"value": {
"times": [ "07:00", "16:30", "23:30" ]
}
}
},
"responses": {
"200": {}
}
},
"disable scheduled refresh": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"datasetDQRefreshScheduleRequest": {
"value": {
"enabled": false
}
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/parameters": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of parameters for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).<h2>Restrictions</h2>Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.<br/>",
"operationId": "Datasets_GetParameters",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MashupParameters"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "ServerName",
"type": "Text",
"isRequired": true,
"currentValue": "MyTest.database.windows.net"
},
{
"name": "DatabaseName",
"type": "Text",
"isRequired": true,
"currentValue": "MyTestDB"
},
{
"name": "FromDate",
"type": "DateTime",
"isRequired": true,
"currentValue": "2/8/2002 12:00:00 AM"
},
{
"name": "FilterBlanks",
"type": "Logical",
"isRequired": true,
"currentValue": "TRUE"
},
{
"name": "MaxId",
"type": "Number",
"isRequired": true,
"currentValue": "77"
},
{
"name": "AnyParam",
"type": "Any",
"isRequired": true,
"currentValue": "uu63"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.UpdateParameters": {
"post": {
"tags": [
"Datasets"
],
"summary": "Updates the parameters values for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Important**: The dataset must be refreshed for new parameters values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.<br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app). <h2>Restrictions</h2><ul><li>All parameters must exist in the dataset. Names are case-sensitive. </li><li>Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported. </li><li>Datasets with Analysis Services Live connections are not supported. </li><li> Maximum of a 100 parameters in request is allowed. </li><li> Values should be of expected Type. </li><li> Cannot pass empty value to an IsRequired parameter. </li><li> List cannot be empty or include multiple occurrences of same parameter. </li><li> Parameters of types 'Any' or 'Binary' cannot be set. </li></ul>",
"operationId": "Datasets_UpdateParameters",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "updateMashupParametersRequest",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateMashupParametersRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"updateMashupParametersRequest": {
"updateDetails": [
{
"name": "DatabaseName",
"newValue": "NewDB"
},
{
"name": "MaxId",
"newValue": "5678"
}
]
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/datasources": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of datasources for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDatasources",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Datasources"
}
}
},
"x-ms-examples": {
"direct query model example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "301",
"connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False",
"datasourceType": "Sql",
"datasourceId": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
"gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
"connectionDetails": {
"server": "MyServer.database.windows.net",
"database": "MyDatabase"
}
}
]
}
}
}
},
"cached model example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"datasourceType": "AnalysisServices",
"datasourceId": "f8c56590-43cb-43bf-8daa-233ba2520f55",
"gatewayId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
"connectionDetails": {
"server": "My-As-Server",
"database": "My-As-Database"
}
},
{
"datasourceType": "Web",
"datasourceId": "96e4bb31-7b77-4b6d-8483-d76855639a23",
"gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
"connectionDetails": {
"url": "http://myWebSource.com"
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.UpdateDatasources": {
"post": {
"tags": [
"Datasets"
],
"summary": "Updates the datasources of the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Important**:<ul><li>The original datasource and the new datasource must have the exact same schema.</li><li>For cached models, the dataset must be refreshed to get the data from the new data sources. Wait 30 minutes for the update datasources operation to complete before refreshing.</li></ul><br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app). <h2>Restrictions</h2><ul><li>Update datasources supports SQL Server, Azure SQL Server, Analysis Services, Azure Analysis Services, OData Feed, and SharePoint datasources. For other datasource types, use [Update Parameters](/rest/api/power-bi/datasets/updateparameters) </li><li>Changing datasource type is not supported. </li><li>Datasources that contain parameters on the connection string are not supported. </li><li>Datasources which are part of Merged or Joined tables are not supported. </li></ul>",
"operationId": "Datasets_UpdateDatasources",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "updateDatasourcesRequest",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateDatasourcesRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"updateDatasourcesRequest": {
"updateDetails": [
{
"datasourceSelector": {
"datasourceType": "Sql",
"connectionDetails": {
"server": "My-Sql-Server",
"database": "My-Sql-Database"
}
},
"connectionDetails": {
"server": "New-Sql-Server",
"database": "New-Sql-Database"
}
},
{
"datasourceSelector": {
"datasourceType": "OData",
"connectionDetails": {
"url": "http://services.odata.org/V4/Northwind/Northwind.svc"
}
},
"connectionDetails": {
"url": "http://services.odata.org/V4/Odata/Northwind.svc"
}
}
]
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.SetAllConnections": {
"post": {
"tags": [
"Datasets"
],
"summary": "Updates all connections for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**:<ul><li>To update connection details for SQL, AS, OData Feed, and SharePoint, use [Update Datasources](/rest/api/power-bi/datasets/updatedatasources). For other datasource types, use [Update Parameters](/rest/api/power-bi/datasets/updateparameters).</li><li>This API only supports SQL DirectQuery datasets.</li></ul><br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_SetAllDatasetConnections",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"description": "The dataset id",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"description": "The body",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectionDetails"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"parameters": {
"connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False"
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.BindToGateway": {
"post": {
"tags": [
"Datasets"
],
"summary": "Binds the specified dataset from **\"My Workspace\"** to the specified gateway with (optional) given set of datasource Ids. This only supports the On-Premises Data Gateway.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_BindToGateway",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"description": "The dataset id",
"required": true,
"type": "string"
},
{
"name": "bindToGatewayRequest",
"in": "body",
"description": "The bind to gateway request",
"required": true,
"schema": {
"$ref": "#/definitions/BindToGatewayRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example without datasourceIds": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"bindToGatewayRequest": {
"gatewayObjectId": "1f69e798-5852-4fdd-ab01-33bb14b6e934"
}
},
"responses": {
"200": {}
}
},
"example with datasourceIds": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"bindToGatewayRequest": {
"gatewayObjectId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
"datasourceObjectIds": [ "dc2f2dac-e5e2-4c37-af76-2a0bc10f16cb", "3bfe5d33-ab7d-4d24-b0b5-e2bb8eb01cf5" ]
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.GetBoundGatewayDatasources": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of gateway datasources for the specified dataset from **\"My Workspace\"**.",
"description": "<br/>**Note**: Use the new [Dataset - Get Datasources](/rest/api/power-bi/datasets/getdatasources) API instead.<br/><br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetGatewayDatasources",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GatewayDatasources"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
"gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
"datasourceType": "Sql",
"connectionDetails": "{\"server\":\"MyServer.database.windows.net\",\"database\":\"MyDatabase\"}"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/datasets/{datasetId}/Default.DiscoverGateways": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of gateways which the specified dataset from **\"My Workspace\"** can be bound to.",
"description": "This API is relevant only for datasets that have at least one on-premises connection. <br/>For datasets with cloud-only connections, it will return an empty list. <br/><br/>**Required scope**: Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_DiscoverGateways",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Gateways"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
"name": "ContosoGateway",
"type": "Resource",
"publicKey": {
"exponent": "AQAB",
"modulus": "o6j2....cLk="
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/RefreshUserPermissions": {
"post": {
"tags": [
"Users"
],
"summary": "Refreshes user permissions in Power BI",
"description": "When a user is granted permissions to a workspace, app, or artifact, it might not be immediately available through API calls. <br/>This operation refreshes user permissions and makes sure the user permissions are fully updated. <br/><br/>**Required scope**: Workspace.Read.All or Workspace.ReadWrite.All<br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app). <h2>Restrictions</h2> User can call this API once per hour.",
"operationId": "Users_RefreshUserPermissions",
"consumes": [
],
"produces": [
],
"parameters": [
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
},
"responses": {
"200": {
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/imports": {
"get": {
"tags": [
"Imports"
],
"summary": "Returns a list of imports from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Imports_GetImports",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Imports"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Succeeded",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
],
"reports": [
{
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
}
]
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Imports"
],
"summary": "Creates new content on **\"My Workspace\"** from .pbix, Excel, Rdl or file path in OneDrive for Business.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app). <h3>Notes</h3><ul><li>To import a file, request Headers should include **Content-Type: multipart/form-data** with the file [encoded as form data](https://www.w3.org/TR/html401/interact/forms.html) in the request body. </li><li>To import xlsx file from OneDrive for Business, request Headers should include **Content-Type: application/json** with [ImportInfo](/rest/api/power-bi/imports/postimport#importinfo) in the request body.</li><li>Import .pbix file from OneDrive is not supported.</li><li>To import large .pbix files between 1 GB and 10 GB, see [Create Temporary Upload Location](/rest/api/power-bi/imports/createtemporaryuploadlocation), supported only for workspaces on premium capacity.</li></ul>",
"operationId": "Imports_PostImport",
"consumes": [
"application/json",
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "datasetDisplayName",
"in": "query",
"required": true,
"description": "The display name of the dataset, should include file extension. Not supported when importing from OneDrive for Business.",
"type": "string"
},
{
"name": "nameConflict",
"in": "query",
"required": false,
"description": "Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.<br/>Only Abort and Overwrite are supported with Rdl files.",
"type": "string",
"enum": [
"Ignore",
"Abort",
"Overwrite",
"CreateOrOverwrite"
],
"x-ms-enum": {
"name": "ImportConflictHandlerMode",
"modelAsExtensible": true,
"values": [
{
"value": "Ignore",
"description": "If dataset with the same name already exists, Import operation will create a new dataset with the same name."
},
{
"value": "Abort",
"description": "If dataset with the same name already exists, Import operation will be aborted."
},
{
"value": "Overwrite",
"description": "If dataset with the same name already exists, Import operation will replace the existing dataset with the new one.<br/>Import operation will fail if there is no conflict or if there are more than one datasets with the same name."
},
{
"value": "CreateOrOverwrite",
"description": "If dataset with the same name already exists, Import operation will replace the existing dataset with the new one.<br/>Import operation will fail if there are more than one datasets with the same name."
}
]
}
},
{
"name": "skipReport",
"in": "query",
"required": false,
"description": "Determines whether to skip report import, if specified value must be 'true'. Only supported for PBIX files.",
"type": "boolean"
},
{
"name": "importInfo",
"in": "body",
"description": "The import to post",
"required": true,
"schema": {
"$ref": "#/definitions/ImportInfo"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Import"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/Import"
}
}
},
"x-ms-examples": {
"Post import example": {
"parameters": {
"consumes": "multipart/form-data;",
"boundary": "f05e5244-f876-43b9-bc87-d71598f6b32a",
"paramType": "form",
"datasetDisplayName": "MyReport",
"nameConflict": "Ignore",
"importInfo": {
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
},
"responses": {
"202": {
"body": {
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
}
}
},
"Post import with skipReport example": {
"parameters": {
"consumes": "multipart/form-data;",
"boundary": "f05e5244-f876-43b9-bc87-d71598f6b32a",
"paramType": "form",
"datasetDisplayName": "MyReport",
"nameConflict": "Ignore",
"skipReport": true,
"importInfo": {
"value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}
},
"responses": {
"202": {
"body": {
"id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}
}
}
}
}
}
},
"/v1.0/myorg/imports/{importId}": {
"get": {
"tags": [
"Imports"
],
"summary": "Returns the specified import from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Imports_GetImport",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "importId",
"in": "path",
"required": true,
"description": "The import id",
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Import"
}
}
},
"x-ms-examples": {
"in progress import example": {
"parameters": {
"importId": "82d9a37a-2b45-4221-b012-cb109b8e30c7"
},
"responses": {
"200": {
"body": {
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Publishing",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [
],
"reports": [
]
}
}
}
},
"completed import example": {
"parameters": {
"importId": "82d9a37a-2b45-4221-b012-cb109b8e30c7"
},
"responses": {
"200": {
"body": {
"id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
"importState": "Succeeded",
"createdDateTime": "2018-05-08T14:56:18.477Z",
"updatedDateTime": "2018-05-08T14:56:18.477Z",
"name": "SalesMarketing",
"connectionType": "import",
"source": "Upload",
"datasets": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
],
"reports": [
{
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/imports/createTemporaryUploadLocation": {
"post": {
"tags": [
"Imports"
],
"summary": "Creates a temporary blob storage to be used to import large .pbix files larger than 1 GB and up to 10 GB.",
"description": "To import large .pbix files, create a temporary upload location and upload the .pbix file using the shared access signature (SAS) url from the response, and then call [Post Import](/rest/api/power-bi/imports/postimport) and specify 'fileUrl' to be the SAS url in the [Request Body](/rest/api/power-bi/imports/postimport#request-body)<br/><br/>**Note**: Import large .pbix files is only available for workspaces on premium capacity and for .pbix files that are between 1 GB and 10 GB. <br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Imports_CreateTemporaryUploadLocation",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TemporaryUploadLocation"
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports": {
"get": {
"tags": [
"Reports"
],
"summary": "Returns a list of reports from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Report.ReadWrite.All or Report.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_GetReports",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Reports"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}": {
"get": {
"tags": [
"Reports"
],
"summary": "Returns the specified report from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Report.ReadWrite.All or Report.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_GetReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "reportId",
"description": "The report id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Report"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"reportId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {
"body": {
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"name": "SalesMarketing",
"webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
"embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Reports"
],
"summary": "Deletes the specified report from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Report.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_DeleteReport",
"consumes": [
],
"produces": [
],
"parameters": [
{
"name": "reportId",
"description": "The report id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"reportId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/Clone": {
"post": {
"tags": [
"Reports"
],
"summary": "Clones the specified report from **\"My Workspace\"**.",
"description": "<br/>Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.<br/>**Required scope**: Content.Create<br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_CloneReport",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "reportId",
"description": "The report id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "requestParameters",
"description": "Clone report parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CloneReportRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Report"
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/Export": {
"get": {
"tags": [
"Reports"
],
"summary": "Exports the specified report from **\"My Workspace\"** to a .pbix file.",
"description": "<br/>**Required scope**: Report.ReadWrite.All or Report.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app). <h2>Restrictions</h2>Export of a report with [Power BI service live connection](https://docs.microsoft.com/en-us/power-bi/desktop-report-lifecycle-datasets) after calling [rebind report](/rest/api/power-bi/reports/RebindReport) is not supported.<br/>",
"operationId": "Reports_ExportReport",
"consumes": [],
"produces": [
"application/zip"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The report id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"schema": {
"type": "file"
},
"description": "Exported File"
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/UpdateReportContent": {
"post": {
"tags": [
"Reports"
],
"summary": "Updates the specified report from **\"My Workspace\"** to have the same content as the report in the request body.",
"description": "<br/>**Required scope**: Report.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_UpdateReportContent",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "reportId",
"description": "The report id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "requestParameters",
"description": "UpdateReportContent parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateReportContentRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Report"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"reportId": "5b218778-e7a5-4d73-8187-f10824047715",
"requestParameters": {
"sourceReport": {
"sourceReportId": "8e4d5880-81d6-4804-ab97-054665050799",
"sourceWorkspaceId": "2f42a406-a075-4a15-bbf2-97ef958c94cb"
},
"sourceType": "ExistingReport"
}
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/Rebind": {
"post": {
"tags": [
"Reports"
],
"summary": "Rebinds the specified report from **\"My Workspace\"** to the requested dataset.",
"description": "<br/>Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.<br/>**Required scope**: Report.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_RebindReport",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The report id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "requestParameters",
"description": "Rebind report parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RebindReportRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/pages": {
"get": {
"tags": [
"Reports"
],
"summary": "Returns a list of pages within the specified report from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Report.ReadWrite.All or Report.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_GetPages",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The report id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Pages"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"reportId": "879445d6-3a9e-4a74-b5ae-7c0ddabf0f11"
},
"responses": {
"200": {
"body": {
"value": [
{
"displayName": "Regional Sales Analysis",
"name": "ReportSection",
"order": "0"
},
{
"displayName": "Geographic Analysis",
"name": "ReportSection1",
"order": "1"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/reports/{reportId}/pages/{pageName}": {
"get": {
"tags": [
"Reports"
],
"summary": "Returns the specified page within the specified report from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Report.ReadWrite.All or Report.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Reports_GetPage",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The report id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "pageName",
"in": "path",
"required": true,
"description": "The page name",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Page"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"reportId": "879445d6-3a9e-4a74-b5ae-7c0ddabf0f11",
"pageName": "ReportSection"
},
"responses": {
"200": {
"body": {
"displayName": "Regional Sales Analysis",
"name": "ReportSection",
"order": "0"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/dashboards": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Returns a list of dashboards from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dashboard.ReadWrite.All or Dashboard.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_GetDashboards",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dashboards"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {},
"responses": {
"200": {
"body": {
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Dashboards"
],
"summary": "Creates a new empty dashboard on **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Content.Create <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_AddDashboard",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "requestParameters",
"description": "Add dashboard parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AddDashboardRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dashboard"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"requestParameters": {
"name": "SalesMarketing"
}
},
"responses": {
"200": {
"body": {
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/dashboards/{dashboardId}": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Returns the specified dashboard from **\"My Workspace\"**.",
"description": "<br/>**Required scope**: Dashboard.ReadWrite.All or Dashboard.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_GetDashboard",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dashboardId",
"description": "The dashboard id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dashboard"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"dashboardId": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af"
},
"responses": {
"200": {
"body": {
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/dashboards/{dashboardId}/tiles": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Returns a list of tiles within the specified dashboard from **\"My Workspace\"**.",
"description": "**Note**: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page. <br/><br/>**Required scope**: Dashboard.ReadWrite.All or Dashboard.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_GetTiles",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dashboardId",
"description": "The dashboard id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tiles"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"dashboardId": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b",
"title": "SalesMarketingTile",
"embedUrl": "https://app.powerbi.com/embed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&tileId=312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b",
"rowSpan": 0,
"colSpan": 0,
"reportId": "5b218778-e7a5-4d73-8187-f10824047715",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/dashboards/{dashboardId}/tiles/{tileId}": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Returns the specified tile within the specified dashboard from **\"My Workspace\"**.",
"description": "**Note**: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page. <br/><br/>**Required scope**: Dashboard.ReadWrite.All or Dashboard.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_GetTile",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dashboardId",
"description": "The dashboard id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "tileId",
"description": "The tile id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tile"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"dashboardId": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"tileId": "312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b"
},
"responses": {
"200": {
"body": {
"id": "312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b",
"title": "SalesMarketingTile",
"embedUrl": "https://app.powerbi.com/embed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&tileId=312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b",
"rowSpan": 0,
"colSpan": 0,
"reportId": "5b218778-e7a5-4d73-8187-f10824047715",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/dashboards/{dashboardId}/tiles/{tileId}/Clone": {
"post": {
"tags": [
"Dashboards"
],
"summary": "Clones the specified tile from **\"My Workspace\"**.",
"description": "<br/>If target report id and target dataset are not specified, the following can occur:<li>When a tile clone is performed within the same workspace, the report and dataset links will be cloned from the source tile.</li><li>When cloning a tile within a different workspace, report and dataset links will be rested, and the tile will be broken.</li><br/>**Required scope**: Dashboard.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Dashboards_CloneTile",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "dashboardId",
"description": "The dashboard id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "tileId",
"description": "The tile id",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "requestParameters",
"description": "Clone tile parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CloneTileRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tile"
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/groups/{groupId}/datasets": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns a list of datasets from the specified workspace.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDatasetsInGroup",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The workspace id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Datasets"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"groupId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"addRowsAPIEnabled": false,
"configuredBy": "john@contoso.com",
"isRefreshable": true,
"isEffectiveIdentityRequired": false,
"isEffectiveIdentityRolesRequired": false,
"isOnPremGatewayRequired": false
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"PushDatasets"
],
"summary": "Creates a new dataset in the specified workspace.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_PostDatasetInGroup",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The workspace id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "dataset",
"in": "body",
"description": "Create dataset parameters",
"required": true,
"schema": {
"$ref": "#/definitions/CreateDatasetRequest"
}
},
{
"name": "defaultRetentionPolicy",
"description": "The default retention policy",
"in": "query",
"required": false,
"type": "string",
"enum": [
"None",
"basicFIFO"
],
"x-ms-enum": {
"name": "DefaultRetentionPolicy",
"modelAsExtensible": true,
"values": [
{
"value": "None",
"description": "None"
},
{
"value": "basicFIFO",
"description": "basicFIFO"
}
]
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Dataset"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/Dataset"
}
}
},
"x-ms-examples": {
"Push example": {
"parameters": {
"groupId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"defaultRetentionPolicy": "basicFIFO",
"dataset": {
"name": "SalesMarketing",
"defaultMode": "Push",
"tables": [
{
"name": "Product",
"columns": [
{
"name": "ProductID",
"dataType": "Int64"
},
{
"name": "Name",
"dataType": "string"
},
{
"name": "Category",
"dataType": "string"
},
{
"name": "IsCompete",
"dataType": "bool"
},
{
"name": "ManufacturedOn",
"dataType": "DateTime"
}
]
}
]
}
},
"responses": {
"201": {
"body": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"defaultRetentionPolicy": "basicFIFO"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/groups/{groupId}/datasets/{datasetId}": {
"get": {
"tags": [
"Datasets"
],
"summary": "Returns the specified dataset from the specified workspace.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetDatasetInGroup",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"description": "The workspace id",
"type": "string",
"format": "uuid"
},
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dataset"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"groupId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
"body": {
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"name": "SalesMarketing",
"addRowsAPIEnabled": false,
"configuredBy": "john@contoso.com",
"isRefreshable": true,
"isEffectiveIdentityRequired": true,
"isEffectiveIdentityRolesRequired": true,
"isOnPremGatewayRequired": false
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Datasets"
],
"summary": "Deletes the specified dataset from the specified workspace.",
"description": "<br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_DeleteDatasetInGroup",
"consumes": [
],
"produces": [
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"description": "The workspace id",
"type": "string",
"format": "uuid"
},
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"x-ms-examples": {
"example": {
"parameters": {
"groupId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/tables": {
"get": {
"tags": [
"PushDatasets"
],
"summary": "Returns a list of tables within the specified dataset from the specified workspace.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**Required scope**: Dataset.ReadWrite.All or Dataset.Read.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_GetTablesInGroup",
"consumes": [
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"description": "The workspace id",
"type": "string",
"format": "uuid"
},
{
"name": "datasetId",
"description": "The dataset id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tables"
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/tables/{tableName}": {
"put": {
"tags": [
"PushDatasets"
],
"summary": "Updates the metadata and schema for the specified table, within the specified dataset, from the specified workspace.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**Required scope**: Dataset.ReadWrite.All <br/>To set the permissions scope, see [Register an app](https://docs.microsoft.com/power-bi/developer/register-app).",
"operationId": "Datasets_PutTableInGroup",
"consumes": [
],
"produces": [
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"description": "The workspace id",
"type": "string",
"format": "uuid"
},
{
"name": "datasetId",
"in": "path",
"description": "The dataset id",
"required": true,
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The table name",
"required": true,
"type": "string"
},
{
"name": "requestMessage",
"in": "body",
"description": "The request message",
"required": true,
"schema": {
"$ref": "#/definitions/Table"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Table"
}
}
},
"x-ms-examples": {
"example": {
"parameters": {
"groupId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"tableName": "Product",
"requestMessage": {
"tableName": "NewProduct",
"columns": [
{
"name": "ProductID",
"dataType": "Int64"
},
{
"name": "Name",
"dataType": "string"
},
{
"name": "Category",
"dataType": "string"
},
{
"name": "IsCompete",
"dataType": "bool"
},
{
"name": "ManufacturedOn",
"dataType": "DateTime"
},
{
"name": "NewColumn",
"dataType": "string"
}
]
}
},
"responses": {
"200": {
"body": {
"name": "NewProduct"
}
}
}
}
},
"deprecated": false
}
},
"/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/tables/{tableName}/rows": {
"post": {
"tags": [
"PushDatasets"
],
"summary": "Adds new data rows to the specified table, within the specified dataset, from the specified workspace.",
"description": "<br/>**Note**: This API supports only Push datasets. <br/><br/>**REST API Limitations:** See [Power BI REST API limitations](https://msdn.microsoft.com/library/dn950053.aspx). <br/><br/>**Required scope**: Dataset.R