Edit

Share via

Items - Get KQL Queryset Definition

Service:
KQLQueryset
API Version:
v1

Returns the specified KQL queryset public definition.
This API supports long running operations (LRO).

Permissions

The caller must have read and write permissions for the KQL queryset.

Required Delegated Scopes

KQLQueryset.ReadWrite.All or Item.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 Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition?format={format}

URI Parameters

Name In Required Type Description
kqlQuerysetId
 path True

string (uuid)

The KQL queryset ID.
workspaceId
 path True

string (uuid)

The workspace ID.
format
 query

string

The format of the KQL queryset public definition.

Responses

Name Type Description
200 OK

KQLQuerysetDefinitionResponse

Request completed successfully.
202 Accepted

Request accepted. Retrieving the definition is in progress.

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a KQL queryset definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/314fff62-7c47-4225-9a6c-1a2220f4ce32/kqlQuerysets/9b7de20c-a62f-470e-931d-e7e53f373c0c/getDefinition

Sample response

Status code:
200 
{
  "definition": {
    "parts": [
      {
        "path": "RealTimeQueryset.json",
        "payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIktRTFF1ZXJ5c2V0IiwKICAgICJkaXNwbGF5TmFtZSI6ICJjeHp2ZWFyZ2giLAogICAgImRlc2NyaXB0aW9uIjogImN4enZlYXJnaCIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
KQLQuerysetDefinition

KQL queryset public definition object.
KQLQuerysetDefinitionPart

KQL queryset definition part object.
KQLQuerysetDefinitionResponse

KQL queryset public definition response.
PayloadType

The type of the definition part payload. Additional payload types may be added over time.

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.

KQLQuerysetDefinition

Object

KQL queryset public definition object.

Name Type Description
format

string

The format of the item definition.
parts

KQLQuerysetDefinitionPart[]

A list of definition parts.

KQLQuerysetDefinitionPart

Object

KQL queryset definition part object.

Name Type Description
path

string

The KQL queryset part path.
payload

string

The KQL queryset part payload.
payloadType

PayloadType

The payload type.

KQLQuerysetDefinitionResponse

Object

KQL queryset public definition response.

Name Type Description
definition

KQLQuerysetDefinition

KQL queryset public definition object.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value Description
InlineBase64

Inline Base 64.