Generate DAX - Updates a relationship between two tables in a Power BI dataset within a specific workspace

Updates a relationship between two tables in a Power BI dataset within a specific workspace.

post

Authorizations

Path parameters

workspaceIdstringRequired

Enter ID of the workspace for which the relationship is updated.

datasetIdstringRequired

Enter ID of an existing dataset

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Body

application/jsonapplication/*+jsontext/json

Model for updating existing relationships between tables.

fromTableNamestringRequired

A public property of type string that specifies the name of the 'from' table in the existing relationship.

fromColumnNamestringRequired

A public property of type string that specifies the name of the 'from' column in the existing relationship.

toTableNamestringRequired

A public property of type string that specifies the name of the 'to' table in the existing relationship.

toColumnNamestringRequired

A public property of type string that specifies the name of the 'to' column in the existing relationship.

newFromTableNamestring | nullableOptional

A public property of type string that specifies the new name of the 'from' table for the updated relationship.

newFromColumnNamestring | nullableOptional

A public property of type string that specifies the new name of the 'from' column for the updated relationship.

newToTableNamestring | nullableOptional

A public property of type string that specifies the new name of the 'to' table for the updated relationship.

newToColumnNamestring | nullableOptional

A public property of type string that specifies the new name of the 'to' column for the updated relationship.

fromCardinalitystring · enum | nullableOptional

A public property of type string that specifies the cardinality of the 'from' side of the existing relationship.

Possible values:

newFromCardinalitystring · enum | nullableOptional

A public property of type string that specifies the new cardinality of the 'from' side for the updated relationship.

Possible values:

toCardinalitystring · enum | nullableOptional

A public property of type string that specifies the cardinality of the 'to' side of the existing relationship.

Possible values:

newToCardinalitystring · enum | nullableOptional

A public property of type string that specifies the new cardinality of the 'to' side for the updated relationship.

Possible values:

crossFilteringBehaviorstring · enum | nullableOptional

A public property of type string that specifies the cross-filtering behavior of the relationship.

Possible values:

crossFilterDirectionstring · enum | nullableOptional

A public property of type string that specifies the cross-filter direction of the relationship.

Possible values:

securityFilteringDirectionstring · enum | nullableOptional

A public property of type string that specifies the security filtering direction of the relationship.

Possible values:

isActiveboolean | nullableOptional

A public property of type boolean that specifies whether the relationship is active.

Responses

200

Success: The relationship was updated successfully.

application/json

400

Bad Request: The server cannot process the request due to a client error, such as malformed syntax or invalid table/column details.

application/jsontext/plaintext/json

401

Unauthorized: The request lacks valid authentication credentials for the target resource.

application/jsontext/plaintext/json

500

Internal Server Error: An unexpected server error occurred while processing the request.

application/jsontext/plaintext/json

post

HTTPcURLJavaScriptPython

POST /workspace/{workspaceId}/dataset/{datasetId}/updateRelationship HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 417

{
  "fromTableName": "text",
  "fromColumnName": "text",
  "toTableName": "text",
  "toColumnName": "text",
  "newFromTableName": "text",
  "newFromColumnName": "text",
  "newToTableName": "text",
  "newToColumnName": "text",
  "fromCardinality": "One",
  "newFromCardinality": "One",
  "toCardinality": "One",
  "newToCardinality": "One",
  "crossFilteringBehavior": "OneDirection",
  "crossFilterDirection": "Single",
  "securityFilteringDirection": "Single",
  "isActive": true
}

application/jsonapplication/*+jsontext/json

{
  "message": "text"
}