Items - Get Reflex Definition

Service:

Reflex

API-versie:

v1

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

Wanneer u de openbare definitie van Reflex krijgt, maakt het gevoeligheidslabel geen deel uit van de definitie.

Machtigingen

De beller moet lees- en schrijfmachtigingen voor de reflex hebben.

Vereiste gedelegeerde bereiken

Reflex.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Deze API wordt geblokkeerd voor een Reflex met een versleuteld vertrouwelijkheidslabel.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
reflexId	path	True	string (uuid)	De Reflex ID.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
format	query		string	De indeling van de openbare reflexdefinitie.

Antwoorden

Name	Type	Description
200 OK	ReflexDefinitionResponse	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 Reflex definition example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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.
ReflexDefinition	Reflex public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een openbare reflexdefinitie.
ReflexDefinitionPart	Reflexdefinitieonderdeelobject.
ReflexDefinitionResponse	Reactie op de openbare definitie van Reflex.

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.

ReflexDefinition

Object

Reflex public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een openbare reflexdefinitie.

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

ReflexDefinitionPart

Object

Reflexdefinitieonderdeelobject.

Name	Type	Description
path	string	Het deelpad van de reflex openbare definitie.
payload	string	De nettolading van het onderdeel Reflex public definition.
payloadType	PayloadType	Het nettoladingstype.

ReflexDefinitionResponse

Object

Reactie op de openbare definitie van Reflex.

Name	Type	Description
definition	ReflexDefinition	Reflex public definition object. Raadpleeg dit artikel voor meer informatie over het maken van een openbare reflexdefinitie.