Items - Get Queryable Graph Type (preview)

Service:

GraphModel

API Version:

v1

Get the current queryable graph type.

Note

GraphModel item is currently in Preview (learn more). This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. When calling this API, callers must specify true as the value for the query parameter beta (preview query parameter has been replaced by beta. For backward compatibility, preview is still supported and behaves the same as beta).

This API supports pagination.

Permissions

The caller must have a viewer workspace role. The caller must have read permissions for the graph model.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	No

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphModels/{GraphModelId}/getQueryableGraphType?beta={beta}

URI Parameters

Name	In	Required	Type	Description
GraphModelId	path	True	string (uuid)	The GraphModel ID.
workspaceId	path	True	string (uuid)	The workspace ID.
beta	query	True	boolean	This required parameter must be set to true to access this API, which is currently in beta.

Responses

Name	Type	Description
200 OK	GraphType	The current queryable graph type.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

Examples

Get queryable graph type example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/GraphModels/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getQueryableGraphType?beta=True

Sample response

Status code:

200

{
  "nodeTypes": [
    {
      "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6",
      "primaryKeyProperties": [
        "customerIDK"
      ],
      "labels": [
        "customer"
      ],
      "properties": [
        {
          "name": "customerIDK",
          "type": "INT"
        },
        {
          "name": "firstName",
          "type": "STRING"
        },
        {
          "name": "lastName",
          "type": "STRING"
        },
        {
          "name": "fullName",
          "type": "STRING"
        }
      ]
    },
    {
      "alias": "dced4642-b93d-4da4-815c-a171932043a4",
      "primaryKeyProperties": [
        "productIDK"
      ],
      "labels": [
        "products"
      ],
      "properties": [
        {
          "name": "productIDK",
          "type": "INT"
        },
        {
          "name": "productNumber",
          "type": "STRING"
        },
        {
          "name": "productName",
          "type": "STRING"
        },
        {
          "name": "modelName",
          "type": "STRING"
        },
        {
          "name": "makeFlag",
          "type": "INT"
        },
        {
          "name": "standardCost",
          "type": "FLOAT"
        },
        {
          "name": "listPrice",
          "type": "FLOAT"
        },
        {
          "name": "subCategoryIDFK",
          "type": "INT"
        }
      ]
    }
  ],
  "edgeTypes": [
    {
      "alias": "3ef6a474-ef38-4923-abcf-6f2e9230f1eb",
      "labels": [
        "customerProducts"
      ],
      "sourceNodeType": {
        "alias": "096a5133-fd82-4000-ac8a-404532ab6fd6"
      },
      "destinationNodeType": {
        "alias": "dced4642-b93d-4da4-815c-a171932043a4"
      },
      "properties": []
    }
  ]
}

Definitions

Name	Description
EdgeType	A graph edge type.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GraphType	The graph type that specifies the structure of a graph.
NodeType	A graph node type.
NodeTypeReference	A reference to a node type.
Property	A graph element property.

EdgeType

Object

A graph edge type.

Name	Type	Description
alias	string	The edge type alias.
destinationNodeType	NodeTypeReference	The target node type.
labels	string[]	The edge type labels.
properties	Property[]	A list of edge type properties.
sourceNodeType	NodeTypeReference	The source node type.

ErrorRelatedResource

Object

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

Object

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

Object

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.

GraphType

Object

The graph type that specifies the structure of a graph.

Name	Type	Description
edgeTypes	EdgeType[]	A list of graph edge types.
nodeTypes	NodeType[]	A list of graph node types.

NodeType

Object

A graph node type.

Name	Type	Description
alias	string	The node type alias.
labels	string[]	The node type labels.
primaryKeyProperties	string[]	A list of node type primary key properties.
properties	Property[]	A list of node type properties.

NodeTypeReference

Object

A reference to a node type.

Name	Type	Description
alias	string	The node type alias.

Property

Object

A graph element property.

Name	Type	Description
name	string	The property name.
type	string	The property type.