Items - List Item Connections

  • Reference
Service:
Core
API Version:
v1

Returns the list of connections that the specified item is connected to.

This API supports pagination.

Permissions

The caller must have contributor or higher role on the workspace.

Required Delegated Scopes

For item APIs use these scope types:

  • Generic scope: Item.ReadWrite.All
  • Specific scope: itemType.ReadWrite.All (for example: Notebook.ReadWrite.All)

for more information about scopes, see Scopes article.

Limitations

This API is blocked for an item with a protected sensitivity label, unless the caller has the usage rights to delete the sensitivity label.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal Yes
Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
itemId
 path True

string

uuid

The item ID.
workspaceId
 path True

string

uuid

The workspace ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

ItemConnections

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - Indicates that the server cannot find the requested item.

Examples

List item connections - Semantic Model Direct Lake example
List item connections example
List item connections with continuation example

List item connections - Semantic Model Direct Lake example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Sample response

Status code:
200 
{
  "value": [
    {
      "connectivityType": "DefaultSetting",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

List item connections example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Sample response

Status code:
200 
{
  "value": [
    {
      "connectivityType": "ShareableCloud",
      "displayName": "ContosoConnection1",
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      }
    },
    {
      "connectivityType": "OnPremisesDataGateway",
      "displayName": "ContosoConnection2",
      "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
      "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
      "connectionDetails": {
        "type": "SQL",
        "path": "contoso.database.windows.net;sales"
      }
    }
  ]
}

List item connections with continuation example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

Sample response

Status code:
200 
{
  "value": [
    {
      "connectivityType": "DefaultSetting",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

Definitions

Name Description
ConnectivityType

The connectivity type of the connection. Additional connectivity types may be added over time.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemConnection
ItemConnections
ListConnectionDetails

The connection details output for list operations.

ConnectivityType

The connectivity type of the connection. Additional connectivity types may be added over time.

Name Type Description
Automatic

string

The connection connects through the cloud using an implicit data connection. This option is only available for specific scenarios like semantic models that use Single Sign-On (SSO).”
None

string

The connection is not bound
OnPremisesGateway

string

The connection connects through an on-premises data gateway.
OnPremisesGatewayPersonal

string

The connection connects through a personal on-premises data gateway.
PersonalCloud

string

The connection connects through the cloud and cannot be shared with others.
ShareableCloud

string

The connection connects through the cloud and can be shared with others.
VirtualNetworkGateway

string

The connection connects through a virtual network data gateway.

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

ItemConnection

Name Type Description
connectionDetails

ListConnectionDetails

The connection details of the connection.
connectivityType

ConnectivityType

The connectivity type of the connection.
displayName

string

The display name of the connection. Maximum length is 200 characters.
gatewayId

string

The gateway object ID of the connection.
id

string

The object ID of the connection.

ItemConnections

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

ItemConnection[]

A list of item connections

ListConnectionDetails

The connection details output for list operations.

Name Type Description
path

string

The path of the connection.
type

string

The type of the connection.