Items - Get GraphQLApi Definition

Dienst:

GraphQLApi

API-Version:

v1

Gibt die angegebene öffentliche GraphQLApi-Definition zurück.

Diese API unterstützt LRO-.

Wenn Sie eine öffentliche GraphQLApi-Definition erhalten, ist die Vertraulichkeitsbezeichnung kein Bestandteil der Definition.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für die GraphQLApi besitzen.

Erforderliche delegierte Bereiche

GraphQLApi.ReadWrite.All oder Item.ReadWrite.All

Einschränkungen

Diese API wird für eine mit einer verschlüsselten Vertraulichkeitsbezeichnung blockiert.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützung
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/getDefinition

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
GraphQLApiId	path	True	string (uuid)	Die GraphQLApi-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
format	query		string	Das Format der öffentlichen GraphQLApi-Definition.

Antworten

Name	Typ	Beschreibung
200 OK	GraphQLApiDefinitionResponse	Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted		Anforderung angenommen. Das Abrufen der Definition wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

Beispiele

Get a GraphQLApi public definition example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "definition": {
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Statuscode:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GraphQLApiDefinitionResponse	API für die öffentliche GraphQL-Definitionsantwort.
GraphQLApiPublicDefinition	API für öffentliches GraphQL-Definitionsobjekt. Informationen zum Erstellen der Definition finden Sie unter GraphQLApi-Definition.
GraphQLApiPublicDefinitionPart	API für GraphQL-Definitionsteilobjekt.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GraphQLApiDefinitionResponse

Objekt

API für die öffentliche GraphQL-Definitionsantwort.

Name	Typ	Beschreibung
definition	GraphQLApiPublicDefinition	API für öffentliches GraphQL-Definitionsobjekt. Informationen zum Erstellen der Definition finden Sie unter GraphQLApi-Definition.

GraphQLApiPublicDefinition

Objekt

API für öffentliches GraphQL-Definitionsobjekt. Informationen zum Erstellen der Definition finden Sie unter GraphQLApi-Definition.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	GraphQLApiPublicDefinitionPart[]	Eine Liste der Definitionsteile.

GraphQLApiPublicDefinitionPart

Objekt

API für GraphQL-Definitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der API für den GraphQL-Definitionsteilpfad.
payload	string	Die API für Die Nutzlast des GraphQL-Definitionsteils.
payloadType	PayloadType	Der Nutzlasttyp.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.