Items - Get Variable Library Definition

Service:

VariableLibrary

API-versie:

v1

Retourneert de openbare definitie van de opgegeven variabelebibliotheek.
Deze API ondersteunt langlopende bewerkingen (LRO).

Wanneer u de openbare definitie van VariableLibrary krijgt, maakt het vertrouwelijkheidslabel geen deel uit van de definitie.

Machtigingen

De aanroeper moet lees- en schrijfmachtigingen hebben voor de variabelebibliotheek.

Vereiste gedelegeerde bereiken

VariableLibrary.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}/VariableLibraries/{variableLibraryId}/getDefinition

Met optionele parameters:

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

URI-parameters

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

Antwoorden

Name	Type	Description
200 OK	VariableLibraryDefinitionResponse	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 VariableLibrary public definition example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

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

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
VariableLibraryDefinitionResponse	Antwoord op de openbare definitie van VariableLibrary.
VariableLibraryPublicDefinition	VariableLibrary public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een variabelelibrary openbare definitie.
VariableLibraryPublicDefinitionPart	VariableLibrary definition part object.

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.

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.

VariableLibraryDefinitionResponse

Object

Antwoord op de openbare definitie van VariableLibrary.

Name	Type	Description
definition	VariableLibraryPublicDefinition	VariableLibrary public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een variabelelibrary openbare definitie.

VariableLibraryPublicDefinition

Object

VariableLibrary public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een variabelelibrary openbare definitie.

Name	Type	Description
format	string	De indeling van de itemdefinitie. Ondersteunde indeling: VariableLibraryV1.
parts	VariableLibraryPublicDefinitionPart[]	Een lijst met definitieonderdelen.

VariableLibraryPublicDefinitionPart

Object

VariableLibrary definition part object.

Name	Type	Description
path	string	Het pad van het onderdeel VariableLibrary public definition.
payload	string	De payload van het openbare definitieonderdeel VariableLibrary.
payloadType	PayloadType	Het nettoladingstype.