Items - Get Variable Library Definition

Tjeneste:

VariableLibrary

API-versjon:

v1

Returnerer den angitte fellesdefinisjonen for variabelbiblioteket.
Denne API-en støtter langvarige operasjoner (LRO).

Når du får en variabellibrarys offentlige definisjon, er ikke følsomhetsetiketten en del av definisjonen.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for variabelbiblioteket.

Nødvendige delegerte omfang

VariableLibrary.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/getDefinition

Med valgfrie parametere:

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
variableLibraryId	path	True	string (uuid)	VariableLibrary-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.
format	query		string	Formatet for den offentlige definisjonen variablelibrary.

Svar

Navn	Type	Beskrivelse
200 OK	VariableLibraryDefinitionResponse	Forespørselen er fullført.
202 Accepted		Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: OperationNotSupportedForItem – operasjonen støttes ikke for forespurt element.

Eksempler

Get a VariableLibrary public definition example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

200

{
  "definition": {
    "parts": [
      {
        "path": "variables.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "valueSets/valueSet1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "settings.json",
        "payload": "eyJleGVjdXRhYmxlRm..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

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
VariableLibraryDefinitionResponse	VariableLibrary public definition response.
VariableLibraryPublicDefinition	VariableLibrary public definition object. Se denne artikkelen for mer informasjon om hvordan du oppretter en variabellibrary offentlig definisjon.
VariableLibraryPublicDefinitionPart	VariableLibrary definition part object.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.

VariableLibraryDefinitionResponse

Object

VariableLibrary public definition response.

Navn	Type	Beskrivelse
definition	VariableLibraryPublicDefinition	VariableLibrary public definition object. Se denne artikkelen for mer informasjon om hvordan du oppretter en variabellibrary offentlig definisjon.

VariableLibraryPublicDefinition

Object

VariableLibrary public definition object. Se denne artikkelen for mer informasjon om hvordan du oppretter en variabellibrary offentlig definisjon.

Navn	Type	Beskrivelse
format	string	Formatet for elementdefinisjonen. Støttet format: VariableLibraryV1.
parts	VariableLibraryPublicDefinitionPart[]	En liste over definisjonsdeler.

VariableLibraryPublicDefinitionPart

Object

VariableLibrary definition part object.

Navn	Type	Beskrivelse
path	string	Den offentlige definisjonsdelbanen for VariableLibrary.
payload	string	VariableLibrary public definition part payload.
payloadType	PayloadType	Nyttelasttypen.