The current v1 of datasets API only allows for a dataset to be created with a name and a collection of tables. Each table can have a name and a collection of columns. Each column has a name and datatype. We are expanding these properties most notably with support for measures and relationships between tables. The complete list of supported properties for this release is as follows:
A string describing how the value should be formatted when it is displayed. To learn more about string formatting, see FORMAT_STRING Contents.
False
False
sortByColumn
String
String name of a column in the same table to be used to order the current column.
False
False
dataCategory
String
String value to be used for the data category which describes the data within this column. Some common values include: Address, City, Continent, Country, Image, ImageUrl, Latitude, Longitude, Organization, Place, PostalCode, StateOrProvince, WebUrl
False
False
isHidden
Boolean
Property indicating if the column is hidden from view. Default is false.
False
False
summarizeBy
String
Default aggregation method for the column. Values include: default, none, sum, min, max, count, average, distinctCount
False
False
Measure
Name
Type
Description
Read Only
Required
name
String
User defined name of the measure.
False
True
expression
String
A valid DAX expression.
False
True
formatString
String
A string describing how the value should be formatted when it is displayed. To learn more about string formatting, see FORMAT_STRING Contents.
False
False
isHidden
String
If true, table will be hidden from client tools.
False
False
Relationship
Name
Type
Description
Read Only
Required
name
String
User defined name of the relationship. It is also used as the identifier of the relationship.
False
True
crossFilteringBehavior
String
The filter direction of the relationship: OneDirection (default), BothDirections, Automatic
False
False
fromTable
String
Name of the foreign key table.
False
True
fromColumn
String
Name of the foreign key column.
False
True
toTable
String
Name of the primary key table.
False
True
toColumn
String
Name of the primary key column.
False
True
Data type restrictions
These restrictions apply to dataType property.
Data type
Restrictions
Int64
Int64.MaxValue and Int64.MinValue not allowed.
Double
Double.MaxValue and Double.MinValue values not allowed. NaN not supported.+Infinity and -Infinity not supported in some functions (e.g. Min, Max).
Boolean
True or False.
Datetime
During data loading we quantize values with day fractions to whole multiples of 1/300 seconds (3.33ms).
String
Currently allows up to 4000 characters per string value.
Decimal
precision=28, scale=4
Example
The following code sample includes a number of these properties: