Items - Get KQL Dashboard Definition

Service:

KQLDashboard

API-versie:

v1

Retourneert de openbare definitie van het opgegeven KQL-dashboard.
Deze API ondersteunt langlopende bewerkingen (LRO).

Machtigingen

De aanroeper moet inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

KQLDashboard.ReadWrite.All of Item.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}/getDefinition

Met optionele parameters:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDashboards/{kqlDashboardId}/getDefinition?format={format}

URI-parameters

Name	In	Vereist	Type	Description
kqlDashboardId	path	True	string (uuid)	De KQL-dashboard-id.
workspaceId	path	True	string (uuid)	De werkruimte-id.
format	query		string	De indeling van de openbare definitie van het KQL-dashboard.

Antwoorden

Name	Type	Description
200 OK	KQLDashboardDefinitionResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get a KQL dashboard definition example

Voorbeeldaanvraag

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/kqlDashboards/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Voorbeeldrespons

Statuscode:

200

{
  "definition": {
    "parts": [
      {
        "path": "RealTimeDashboard.json",
        "payload": "ewogICJhdXRvUmVmcmVzaCI6IHsKICAgICJlbmFibGVkIjogZmFsc2UKICB9LAogICJiYXNlUXVlcmllcyI6IFtdLAogICJ0aWxlcyI6IFtdLAogICJkYXRhU291cmNlcyI6IFtdLAogICJwYWdlcyI6IFsKICAgIHsKICAgICAgIm5hbWUiOiAiUGFnZSAxIiwKICAgICAgImlkIjogImFiNWYwNjI4LTk3NTAtNDNlNi05YmE0LTIwMTE2ZTg2ODc1NSIKICAgIH0KICBdLAogICJwYXJhbWV0ZXJzIjogWwogICAgewogICAgICAia2luZCI6ICJkdXJhdGlvbiIsCiAgICAgICJpZCI6ICJmNTEwYjlmZi0xZjI3LTQ4YmQtODBlNC1mZDFhNTllODQ5MjQiLAogICAgICAiZGlzcGxheU5hbWUiOiAiVGltZSByYW5nZSIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICIiLAogICAgICAiYmVnaW5WYXJpYWJsZU5hbWUiOiAiX3N0YXJ0VGltZSIsCiAgICAgICJlbmRWYXJpYWJsZU5hbWUiOiAiX2VuZFRpbWUiLAogICAgICAiZGVmYXVsdFZhbHVlIjogewogICAgICAgICJraW5kIjogImR5bmFtaWMiLAogICAgICAgICJjb3VudCI6IDEsCiAgICAgICAgInVuaXQiOiAiaG91cnMiCiAgICAgIH0sCiAgICAgICJzaG93T25QYWdlcyI6IHsKICAgICAgICAia2luZCI6ICJhbGwiCiAgICAgIH0KICAgIH0KICBdLAogICJxdWVyaWVzIjogW10sCiAgInNjaGVtYV92ZXJzaW9uIjogIjUyIiwKICAidGl0bGUiOiAidmNkem5ncnpzbSIKfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIktRTERhc2hib2FyZCIsCiAgICAiZGlzcGxheU5hbWUiOiAidmNkem5ncnpzbSIsCiAgICAiZGVzY3JpcHRpb24iOiAidmNkem5ncnpzbSIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
KQLDashboardDefinition	Het openbare definitieobject van het KQL-dashboard.
KQLDashboardDefinitionPart	KQL-dashboarddefinitieonderdeelobject.
KQLDashboardDefinitionResponse	Antwoord op openbare definitie van KQL-dashboard.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

KQLDashboardDefinition

Object

Het openbare definitieobject van het KQL-dashboard.

Name	Type	Description
format	string	De indeling van de itemdefinitie.
parts	KQLDashboardDefinitionPart[]	Een lijst met definitieonderdelen.

KQLDashboardDefinitionPart

Object

KQL-dashboarddefinitieonderdeelobject.

Name	Type	Description
path	string	Het pad naar het KQL-dashboardonderdeel.
payload	string	De nettolading van het KQL-dashboardonderdeel.
payloadType	PayloadType	Het nettoladingstype.

KQLDashboardDefinitionResponse

Object

Antwoord op openbare definitie van KQL-dashboard.

Name	Type	Description
definition	KQLDashboardDefinition	Het openbare definitieobject van het KQL-dashboard.

PayloadType

Inventarisatie

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.