Items - Get GraphQLApi Definition

Tjeneste:: GraphQLApi

API-version:: v1

Returnerer den angivne offentlige GraphQLApi-definition.

Denne API understøtter LRO-handlinger (Long Running Operations).

Når du får en offentlig GraphQLApi-definition, er følsomhedsmærkaten ikke en del af definitionen.

Tilladelser

Kalderen skal have læse- og skrivetilladelser til GraphQLApi .

Påkrævede delegerede områder

GraphQLApi.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Denne API er blokeret for en med en krypteret følsomhedsmærkat.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphQLApis/{graphQLApiId}/getDefinition

Med valgfrie parametre:

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
graphQLApiId	path	True	string (uuid)	GraphQLApi-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.
format	query		string	Formatet af den offentlige GraphQLApi-definition.

Svar

Name	Type	Beskrivelse
200 OK	GraphQLApiDefinitionResponse	Anmodningen blev fuldført.
202 Accepted		Anmodningen blev accepteret. Hentning af definitionen er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: OperationNotSupportedForItem – Handlingen understøttes ikke for det ønskede element.

Eksempler

Get a GraphQLApi public definition example

Eksempelanmodning

HTTP

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

Eksempelsvar

Statuskode:: 200

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

Statuskode:: 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

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GraphQLApiDefinitionResponse	API til svar på offentlig GraphQL-definition.
GraphQLApiPublicDefinition	Offentligt definitionsobjekt for GraphQL API. Se denne artikel for at få flere oplysninger om strukturen af GraphQL API-definitionen.
GraphQLApiPublicDefinitionPart	API til GraphQL-definitionsdelobjekt.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GraphQLApiDefinitionResponse

Objekt

API til svar på offentlig GraphQL-definition.

Name	Type	Beskrivelse
definition	GraphQLApiPublicDefinition	Offentligt definitionsobjekt for GraphQL API. Se denne artikel for at få flere oplysninger om strukturen af GraphQL API-definitionen.

GraphQLApiPublicDefinition

Objekt

Offentligt definitionsobjekt for GraphQL API. Se denne artikel for at få flere oplysninger om strukturen af GraphQL API-definitionen.

Name	Type	Beskrivelse
format	string	Formatet af GraphQL-definitionen.
parts	GraphQLApiPublicDefinitionPart[]	En liste over definitionsdele.

GraphQLApiPublicDefinitionPart

Objekt

API til GraphQL-definitionsdelobjekt.

Name	Type	Beskrivelse
path	string	Stien til API'en til GraphQL-definitionsdelen.
payload	string	API'en til GraphQL-definitionsdelens nyttedata.
payloadType	PayloadType	Nyttedatatypen.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.