Items - Get Reflex Definition

Dienst:

Reflex

API-Version:

v1

Gibt die angegebene öffentliche Reflex-Definition zurück.
Diese API unterstützt LRO-.

Wenn Sie die öffentliche Definition eines Reflexs erhalten, ist die Vertraulichkeitsbezeichnung kein Bestandteil der Definition.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für den Reflex besitzen.

Erforderliche delegierte Bereiche

Reflex.ReadWrite.All oder Item.ReadWrite.All

Einschränkungen

Diese API wird für einen Reflex 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}/reflexes/{reflexId}/getDefinition

Mit optionalen Parametern:

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

URI-Parameter

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

Antworten

Name	Typ	Beschreibung
200 OK	ReflexDefinitionResponse	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 Reflex definition example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "definition": {
    "parts": [
      {
        "path": "ReflexEntities.json",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "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.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
ReflexDefinition	Reflex Public Definition-Objekt. Weitere Informationen zum Erstellen einer öffentlichen Reflexdefinition finden Sie in diesem Artikel.
ReflexDefinitionPart	Reflex definition part object.
ReflexDefinitionResponse	Reaktion auf die öffentliche Definition des Reflexs.

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.

PayloadType

Enumeration

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

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

ReflexDefinition

Objekt

Reflex Public Definition-Objekt. Weitere Informationen zum Erstellen einer öffentlichen Reflexdefinition finden Sie in diesem Artikel.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition. Unterstütztes Format: json.
parts	ReflexDefinitionPart[]	Eine Liste der Definitionsteile.

ReflexDefinitionPart

Objekt

Reflex definition part object.

Name	Typ	Beschreibung
path	string	Der Reflex public definition part path.
payload	string	Die Nutzlast der öffentlichen Reflex-Definition.
payloadType	PayloadType	Der Nutzlasttyp.

ReflexDefinitionResponse

Objekt

Reaktion auf die öffentliche Definition des Reflexs.

Name	Typ	Beschreibung
definition	ReflexDefinition	Reflex Public Definition-Objekt. Weitere Informationen zum Erstellen einer öffentlichen Reflexdefinition finden Sie in diesem Artikel.