Items - Get Variable Library Definition

Tjänst:

VariableLibrary

API-version:

v1

Returnerar den angivna offentliga definitionen för variabelbiblioteket.
Det här API:et stöder tidskrävande åtgärder (LRO).

När du får en Offentlig definition för VariableLibrary är känslighetsetiketten inte en del av definitionen.

Behörigheter

Anroparen måste ha läs- och skrivbehörighet för variabelbiblioteket.

Obligatoriska delegerade omfång

VariableLibrary.ReadWrite.All eller Item.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
variableLibraryId	path	True	string (uuid)	VariableLibrary-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.
format	query		string	Formatet för den offentliga definitionen VariableLibrary.

Svar

Name	Typ	Description
200 OK	VariableLibraryDefinitionResponse	Begäran har slutförts.
202 Accepted		Begäran har godkänts. Hämtning av definitionen pågår. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: OperationNotSupportedForItem – Åtgärden stöds inte för det begärda objektet.

Exempel

Get a VariableLibrary public definition example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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"
      }
    ]
  }
}

Statuskod:

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	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.
VariableLibraryDefinitionResponse	VariableLibrarys svar på offentlig definition.
VariableLibraryPublicDefinition	VariableLibrarys offentliga definitionsobjekt. Mer information om strukturen för VariableLibrary-definitionen finns i den här artikeln .
VariableLibraryPublicDefinitionPart	VariableLibrary-definitionsdelsobjekt.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

VariableLibraryDefinitionResponse

Objekt

VariableLibrarys svar på offentlig definition.

Name	Typ	Description
definition	VariableLibraryPublicDefinition	VariableLibrarys offentliga definitionsobjekt. Mer information om strukturen för VariableLibrary-definitionen finns i den här artikeln .

VariableLibraryPublicDefinition

Objekt

VariableLibrarys offentliga definitionsobjekt. Mer information om strukturen för VariableLibrary-definitionen finns i den här artikeln .

Name	Typ	Description
format	string	Formatet för objektdefinitionen. Format som stöds: VariableLibraryV1.
parts	VariableLibraryPublicDefinitionPart[]	En lista över definitionsdelar.

VariableLibraryPublicDefinitionPart

Objekt

VariableLibrary-definitionsdelsobjekt.

Name	Typ	Description
path	string	Den offentliga definitionsdelssökvägen VariableLibrary.
payload	string	Nyttolasten För den offentliga definitionsdelen VariableLibrary.
payloadType	PayloadType	Nyttolasttypen.