Push Datasets - Datasets PostDataset

Service:

Power BI REST APIs

API Version:

v1.0

Crea un nuevo conjunto de datos en Mi área de trabajo.

Ámbito requerido

Dataset.ReadWrite.All

Limitaciones

Esta llamada API solo admite conjuntos de datos de inserción. Para obtener una lista completa de las limitaciones, consulte Limitaciones de los conjuntos de datos de inserción.

POST https://api.powerbi.com/v1.0/myorg/datasets

With optional parameters:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
defaultRetentionPolicy	query		DefaultRetentionPolicy	La directiva de retención predeterminada

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del conjunto de datos
tables	True	Table[]	Tablas del conjunto de datos
datasources		Datasource[]	Orígenes de datos asociados a este conjunto de datos
defaultMode		DatasetMode	Modo o tipo de conjunto de datos
relationships		Relationship[]	Relaciones del conjunto de datos

Respuestas

Nombre	Tipo	Description
201 Created	Dataset	Creado
202 Accepted	Dataset	Aceptado

Ejemplos

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

Request Body

{
  "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"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

Status code:

201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Definiciones

Nombre	Description
ASMashupExpression	Un origen de tabla de conjunto de datos
Column	Una columna de conjunto de datos
CreateDatasetRequest	Un conjunto de datos de Power BI
CrossFilteringBehavior	Dirección del filtro de la relación
Dataset	Un conjunto de datos de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
DatasetMode	Modo o tipo de conjunto de datos
DatasetQueryScaleOutSettings	Consulta de la configuración de escalado horizontal de un conjunto de datos
DatasetUser	Una entrada de derecho de acceso de usuario de Power BI para un conjunto de datos
DatasetUserAccessRight	Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)
Datasource	Un origen de datos de Power BI
DatasourceConnectionDetails	Detalles de conexión del origen de datos de Power BI. Vea ejemplos en Obtener orígenes de datos o Obtener orígenes de datos en grupo.
DefaultRetentionPolicy	Directiva de retención predeterminada
DependentDataflow	Un flujo de datos dependiente de Power BI
Encryption	Información de cifrado de un conjunto de datos
EncryptionStatus	Estado del cifrado del conjunto de datos
Measure	Una medida de Power BI
PrincipalType	Tipo de entidad de seguridad
Relationship	Relación entre tablas de un conjunto de datos
Row	Fila de datos de un conjunto de datos
ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
Table	Una tabla de conjunto de datos

ASMashupExpression

Un origen de tabla de conjunto de datos

Nombre	Tipo	Description
expression	string	Expresión de origen

Column

Una columna de conjunto de datos

Nombre	Tipo	Description
dataCategory	string	Opcional. Valor de cadena que se va a usar para la categoría de datos que describe los datos de esta columna.
dataType	string	Tipo de datos de columna
formatString	string	Opcional. Formato de la columna tal y como se especifica en FORMAT_STRING.
isHidden	boolean	Opcional. Si la columna está oculta. De manera predeterminada, es false.
name	string	Nombre de columna
sortByColumn	string	Opcional. Nombre de cadena de una columna de la misma tabla que se va a usar para ordenar la columna actual.
summarizeBy	string	Opcional. Función de agregado que se va a usar para resumir esta columna.

CreateDatasetRequest

Un conjunto de datos de Power BI

Nombre	Tipo	Description
datasources	Datasource[]	Orígenes de datos asociados a este conjunto de datos
defaultMode	DatasetMode	El modo o el tipo del conjunto de datos
name	string	Nombre del conjunto de datos
relationships	Relationship[]	Relaciones del conjunto de datos
tables	Table[]	Tablas del conjunto de datos

CrossFilteringBehavior

Dirección del filtro de la relación

Nombre	Tipo	Description
Automatic	string	El comportamiento de filtrado cruzado se define automáticamente
BothDirections	string	Con fines de filtrado, ambas tablas se tratan como una sola tabla.
OneDirection	string	Con fines de filtrado, el filtro se aplicará en la tabla donde se agregan los valores.

Dataset

Un conjunto de datos de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

Nombre	Tipo	Description
ContentProviderType	string	Tipo de proveedor de contenido para el conjunto de datos
CreateReportEmbedURL	string	Dirección URL de inserción del informe de creación del conjunto de datos
CreatedDate	string	Fecha y hora de creación del conjunto de datos
Encryption	Encryption	Información de cifrado del conjunto de datos. Solo se aplica cuando $expand se especifica .
IsEffectiveIdentityRequired	boolean	Si el conjunto de datos requiere una identidad eficaz, que debe enviar en una llamada a la API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Si la seguridad de nivel de fila se define dentro del archivo .pbix de Power BI. Si es así, debe especificar un rol.
IsInPlaceSharingEnabled	boolean	Si el conjunto de datos se puede compartir con usuarios externos que se van a consumir en su propio inquilino
IsOnPremGatewayRequired	boolean	Si el conjunto de datos requiere una puerta de enlace de datos local
IsRefreshable	boolean	Si el conjunto de datos es actualizable o no. Un conjunto de datos actualizable de Power BI es un conjunto de datos que se ha actualizado al menos una vez o para el que existe una programación de actualización válida.
QnaEmbedURL	string	Dirección URL de inserción de Q&del conjunto de datos
addRowsAPIEnabled	boolean	Si el conjunto de datos permite agregar nuevas filas
configuredBy	string	Propietario del conjunto de datos
description	string	Descripción del conjunto de datos
id	string	Identificador del conjunto de datos
name	string	Nombre del conjunto de datos
queryScaleOutSettings	DatasetQueryScaleOutSettings	Consulta de la configuración de escalabilidad horizontal de un conjunto de datos
targetStorageMode	string	Modo de almacenamiento del conjunto de datos
upstreamDataflows	DependentDataflow[]	La lista de todos los flujos de datos de este elemento depende de
users	DatasetUser[]	(Valor vacío) Detalles de acceso del usuario del conjunto de datos. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un elemento de Power BI (por ejemplo, un informe o un panel) mediante la API Obtener usuarios del conjunto de datos como Administración API o postWorkspaceInfo API con el getArtifactUsers parámetro .
webUrl	string	Dirección URL web del conjunto de datos

DatasetMode

Modo o tipo de conjunto de datos

Nombre	Tipo	Description
AsAzure	string	Un conjunto de datos con una conexión dinámica a Azure Analysis Services
AsOnPrem	string	Un conjunto de datos con una conexión dinámica a Azure Analysis Services local
Push	string	Conjunto de datos que permite el acceso mediante programación para insertar datos en Power BI
PushStreaming	string	Un conjunto de datos que admite el streaming de datos y permite el acceso mediante programación para insertar datos en Power BI.
Streaming	string	Un conjunto de datos que admite el streaming de datos. Para más información, consulte Streaming en tiempo real en Power BI.

DatasetQueryScaleOutSettings

Consulta de la configuración de escalado horizontal de un conjunto de datos

Nombre	Tipo	Description
autoSyncReadOnlyReplicas	boolean	Si el conjunto de datos sincroniza automáticamente las réplicas de solo lectura
maxReadOnlyReplicas	integer	Número máximo de réplicas de solo lectura para el conjunto de datos (0-64, -1 para el número automático de réplicas)

DatasetUser

Una entrada de derecho de acceso de usuario de Power BI para un conjunto de datos

Nombre	Tipo	Description
datasetUserAccessRight	DatasetUserAccessRight	Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)
displayName	string	Nombre para mostrar de la entidad de seguridad
emailAddress	string	Dirección de correo electrónico del usuario
graphId	string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	Tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.

DatasetUserAccessRight

Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)

Nombre	Tipo	Description
None	string	Quita el permiso para el contenido del conjunto de datos.
Read	string	Concede acceso de lectura al contenido del conjunto de datos.
ReadExplore	string	Concede acceso de lectura y exploración al contenido del conjunto de datos.
ReadReshare	string	Concede acceso de lectura y recompartición al contenido del conjunto de datos
ReadReshareExplore	string	Concede acceso de lectura, volver a compartir y explorar el contenido del conjunto de datos.
ReadWrite	string	Concede acceso de lectura y escritura al contenido del conjunto de datos.
ReadWriteExplore	string	Concede acceso de lectura, escritura y exploración al contenido del conjunto de datos.
ReadWriteReshare	string	Concede acceso de lectura, escritura y recompartición al contenido del conjunto de datos.
ReadWriteReshareExplore	string	Concede acceso de lectura, escritura, recursos compartidos y exploración al contenido del conjunto de datos.

Datasource

Un origen de datos de Power BI

Nombre	Tipo	Description
connectionDetails	DatasourceConnectionDetails	Detalles de conexión del origen de datos
connectionString	string	(En desuso) El origen de datos cadena de conexión. Disponible solo para DirectQuery.
datasourceId	string	Identificador del origen de datos enlazado, que está vacío cuando no está enlazado a una puerta de enlace.
datasourceType	string	Tipo de origen de datos
gatewayId	string	Identificador de puerta de enlace enlazado, que está vacío cuando no está enlazado a una puerta de enlace. Cuando se usa un clúster de puerta de enlace, el identificador de puerta de enlace hace referencia a la puerta de enlace principal (primera) del clúster y es similar al identificador del clúster de puerta de enlace.
name	string	(En desuso) Nombre del origen de datos. Disponible solo para DirectQuery.

DatasourceConnectionDetails

Detalles de conexión del origen de datos de Power BI. Vea ejemplos en Obtener orígenes de datos o Obtener orígenes de datos en grupo.

Nombre	Tipo	Description
account	string	La cuenta de conexión
classInfo	string	Información de la clase de conexión
database	string	La base de datos de conexión
domain	string	Dominio de conexión
emailAddress	string	La dirección de correo electrónico de conexión
kind	string	El tipo de conexión
loginServer	string	El servidor de inicio de sesión de conexión
path	string	Ruta de acceso de conexión
server	string	El servidor de conexión
url	string	La dirección URL de conexión

DefaultRetentionPolicy

Directiva de retención predeterminada

Nombre	Tipo	Description
None	string	None
basicFIFO	string	basicFIFO

DependentDataflow

Un flujo de datos dependiente de Power BI

Nombre	Tipo	Description
groupId	string	Identificador del grupo de destino
targetDataflowId	string	Identificador del flujo de datos de destino

Encryption

Información de cifrado de un conjunto de datos

Nombre	Tipo	Description
EncryptionStatus	EncryptionStatus	Estado del cifrado del conjunto de datos

EncryptionStatus

Estado del cifrado del conjunto de datos

Nombre	Tipo	Description
InSyncWithWorkspace	string	Se admite el cifrado y está sincronizado con la configuración de cifrado.
NotInSyncWithWorkspace	string	Se admite el cifrado, pero no está sincronizado con la configuración de cifrado.
NotSupported	string	No se admite el cifrado para este conjunto de datos.
Unknown	string	El estado de cifrado es desconocido debido a daños en el conjunto de datos.

Measure

Una medida de Power BI

Nombre	Tipo	Description
description	string	Opcional. Descripción de la medida.
expression	string	Una expresión DAX válida
formatString	string	Opcional. Cadena que describe cómo se debe dar formato al valor cuando se muestra como se especifica en FORMAT_STRING.
isHidden	boolean	Opcional. Si la medida está oculta.
name	string	Nombre de la medida

PrincipalType

Tipo de entidad de seguridad

Nombre	Tipo	Description
App	string	Tipo de entidad de servicio
Group	string	Tipo de entidad de seguridad de grupo
None	string	No hay ningún tipo de entidad de seguridad. Use para el acceso de nivel de organización completo.
User	string	Tipo de entidad de seguridad de usuario

Relationship

Relación entre tablas de un conjunto de datos

Nombre	Tipo	Valor predeterminado	Description
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	Dirección del filtro de la relación
fromColumn	string		Nombre de la columna de clave externa
fromTable	string		Nombre de la tabla de clave externa
name	string		El nombre y el identificador de la relación
toColumn	string		Nombre de la columna de clave principal
toTable	string		Nombre de la tabla de clave principal

Row

Fila de datos de un conjunto de datos

Nombre	Tipo	Description
id	string	Identificador de fila único

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Nombre	Tipo	Description
displayName	string	El nombre del perfil de entidad de servicio
id	string	El identificador de perfil de la entidad de servicio

Table

Una tabla de conjunto de datos

Nombre	Tipo	Description
columns	Column[]	Esquema de columna de esta tabla
description	string	Descripción de la tabla
isHidden	boolean	Opcional. Si esta tabla de conjunto de datos está oculta.
measures	Measure[]	Las medidas de esta tabla
name	string	El nombre de la tabla
rows	Row[]	Filas de datos dentro de esta tabla
source	ASMashupExpression[]	Origen de la tabla