Power BI Connector
Documentation
Version: 2
Documentation

EndPoint Create a Push Dataset


Name

create_push_dataset

Description

Creates a Push Dataset with Tables. [API reference]

Parameters

Parameter Label Required Options Description
Definition Definition YES
Option Value
Example { "name": "SalesMarketing", "defaultMode": "Push", "tables": [ { "name": "Product", "columns": [ { "name": "ProductID", "dataType": "Int64" }, { "name": "Name", "dataType": "string" }, { "name": "Category", "dataType": "string" }, { "name": "IsComplete", "dataType": "bool" }, { "name": "ManufacturedOn", "dataType": "DateTime" }, { "name": "Sales", "dataType": "Double", "formatString": "Currency" } ] } ] }
JSON describing the created Dataset and its Tables
WorkspaceId WorkspaceId NO
Option Value
Default

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_STR varchar(36) 36 False
Name DT_WSTR nvarchar(150) 150 False
Status DT_WSTR nvarchar(30) 30 False
HttpStatusCode DT_I4 int False

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Power BI Connector in API Source component to read data or in API Destination component to read/write data:

Create a Push Dataset using API Source

Power BI
Create a Push Dataset
SSIS API Source - Read from table or endpoint

Create a Push Dataset using API Destination

Power BI
Create a Push Dataset
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Datasets - Create a Push Dataset

SELECT * 
FROM create_push_dataset
WITH (Definition='{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}'
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset

Datasets - Create a Push Dataset with 2 Tables

SELECT * 
FROM create_push_dataset
WITH (Definition='{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
     {
      "name": "Customers",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        }
      ]
    },
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}'
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Datasets - Create a Push Dataset

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * 
FROM create_push_dataset
WITH (Definition=''{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}''
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_POWER_BI_IN_DATA_GATEWAY];

Datasets - Create a Push Dataset with 2 Tables

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * 
FROM create_push_dataset
WITH (Definition=''{
  "name": "My Push Dataset Name",
  "defaultMode": "Push",
  "tables": [
     {
      "name": "Customers",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        }
      ]
    },
	{
      "name": "Products",
      "columns": [
        {
          "name": "Id",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsComplete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        },        
        {
          "name": "Price",
          "dataType": "Double",
          "formatString": "Currency"
        }
      ]
    }
  ]
}''
)

-- More info on creating a Push Dataset:
-- https://learn.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_POWER_BI_IN_DATA_GATEWAY];