Push Datasets - Datasets PostDataset

Servicio:: Power BI REST APIs

Versión de la API:: 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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
defaultRetentionPolicy	query		DefaultRetentionPolicy	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	El modo o el tipo del 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

Solicitud de ejemplo

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

Cuerpo de la solicitud

{
  "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"
        }
      ]
    }
  ]
}

Respuesta de muestra

status code:: 201

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

Definiciones

Nombre	Description
ASMashupExpression	Origen de una 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 denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
DatasetMode	El modo o el tipo del conjunto de datos
DatasetQueryScaleOutSettings	Consulta de la configuración de escalabilidad horizontal de un conjunto de datos
DatasetUser	Una entrada adecuada de acceso de usuario de Power BI para un conjunto de datos
DatasetUserAccessRight	Derecho de acceso que el usuario tiene 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 de Obtener orígenes de datos o obtener orígenes de datos en group.
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 de cifrado del conjunto de datos
Measure	Una medida de Power BI
PrincipalType	El 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 de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
Table	Una tabla de conjunto de datos

ASMashupExpression

Object

Origen de una tabla de conjunto de datos

Nombre	Tipo	Description
expression	string	Expresión de origen

Column

Object

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 como se especifica en FORMAT_STRING.
isHidden	boolean	Opcional. Indica si la columna está oculta. El valor predeterminado es `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nombre de columna
sortByColumn	string	Opcional. Nombre de cadena de una columna de la misma tabla que se usará para ordenar la columna actual.
summarizeBy	string	Opcional. Función de agregado que se va a usar para resumir esta columna.

CreateDatasetRequest

Object

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

Enumeración

Dirección del filtro de la relación

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

Dataset

Object

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 denominada, 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	Propiedad en desuso que se debe omitir.
Encryption	Encryption	Información de cifrado del conjunto de datos. Solo es aplicable cuando se especifica `$expand`.
IsEffectiveIdentityRequired	boolean	Si el conjunto de datos requiere una identidad eficaz, que debe enviar en una llamada API de 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	Este campo devuelve `true` cuando el conjunto de datos se actualiza recientemente o está configurado para la actualización automática, con el modo de conexión establecido específicamente en "Importar". El valor devolverá `false` para otros modos de conexión, como "DirectQuery" y "LiveConnection", independientemente de si el conjunto de datos se actualiza manualmente o está configurado para la actualización automática.
addRowsAPIEnabled	boolean	Si el conjunto de datos permite agregar nuevas filas
configuredBy	string	Propietario del conjunto de datos
createReportEmbedURL	string	Dirección URL de inserción del informe de creación del conjunto de datos
createdDate	string (date-time)	Fecha y hora de creación 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
qnaEmbedURL	string	Dirección URL de inserción del conjunto de datos Q&A
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 el uso de Obtener usuarios del conjunto de datos como API de administrador o la API de PostWorkspaceInfo con el parámetro `getArtifactUsers`.
webUrl	string	Dirección URL web del conjunto de datos

DatasetMode

Enumeración

El modo o el tipo del conjunto de datos

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

DatasetQueryScaleOutSettings

Object

Consulta de la configuración de escalabilidad 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 minimum: -1 maximum: 64	Número máximo de réplicas de solo lectura para el conjunto de datos (de 0 a 64, -1 para el número automático de réplicas)

DatasetUser

Object

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

Nombre	Tipo	Description
datasetUserAccessRight	DatasetUserAccessRight	Derecho de acceso que el usuario tiene 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 administración.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
userType	string	Tipo del usuario.

DatasetUserAccessRight

Enumeración

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

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

Datasource

Object

Un origen de datos de Power BI

Nombre	Tipo	Description
connectionDetails	DatasourceConnectionDetails	Detalles de la conexión del origen de datos
connectionString	string	(en desuso) Cadena de conexión del origen de datos. Solo está disponible para DirectQuery.
datasourceId	string (uuid)	Identificador de origen de datos enlazado, que está vacío cuando no está enlazado a una puerta de enlace.
datasourceType	string	El tipo de origen de datos
gatewayId	string (uuid)	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. Solo está disponible para DirectQuery.

DatasourceConnectionDetails

Object

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

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	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	Dirección URL de conexión

DefaultRetentionPolicy

Enumeración

Directiva de retención predeterminada

Valor	Description
None	Ninguno
basicFIFO	basicFIFO

DependentDataflow

Object

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

Object

Información de cifrado de un conjunto de datos

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

EncryptionStatus

Enumeración

Estado de cifrado del conjunto de datos

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

Measure

Object

Una medida de Power BI

Nombre	Tipo	Description
description	string	Opcional. Descripción de la medida.
expression	string	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. Indica si la medida está oculta.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Nombre de la medida

PrincipalType

Enumeración

El tipo de entidad de seguridad

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

Relationship

Object

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 pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nombre de la columna de clave externa
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Nombre de la tabla de claves externas
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		El nombre y el identificador de la relación
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		Nombre de la columna de clave principal
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		Nombre de la tabla de clave principal

Row

Object

Fila de datos de un conjunto de datos

Nombre	Tipo	Description
id	string	Identificador de fila único

ServicePrincipalProfile

Object

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

Nombre	Tipo	Description
displayName	string	El nombre del perfil de entidad de servicio
id	string (uuid)	Identificador del perfil de la entidad de servicio

Table

Object

Una tabla de conjunto de datos

Nombre	Tipo	Description
columns	Column[]	Esquema de columna para 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 pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	Nombre de la tabla
rows	Row[]	Filas de datos dentro de esta tabla
source	ASMashupExpression[]	Origen de la tabla

Compartir a través de

Push Datasets - Datasets PostDataset

Ámbito requerido

Limitaciones

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Push example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table