Items - Get Digital Twin Builder Flow

Služba:

DigitalTwinBuilderFlow

Verzia rozhrania API:

v1

Poznámka

Toto rozhranie API je vo verzii Preview.

Vráti vlastnosti zadaného postupu Digital Twin Builder.

Povolenia

Volajúci musí mať povolenia na čítanie pre digitálny postup dvojitého zostavovača.

Povinné delegované rozsahy

DigitalTwinBuilderFlow.Read.All alebo DigitalTwinBuilderFlow.ReadWrite.All alebo Item.Read.All alebo Item.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Užívateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/DigitalTwinBuilderFlows/{digitalTwinBuilderFlowId}

Parametre URI

Name	V	Povinné	Typ	Description
digitalTwinBuilderFlowId	path	True	string (uuid)	The Digital Twin Builder Flow ID.
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Odpovede

Name	Typ	Description
200 OK	DigitalTwinBuilderFlow	Požiadavka sa úspešne dokončila.
Other Status Codes	ErrorResponse	Bežné kódy chýb: ItemNotFound – požadovaná položka sa nenašla.

Príklady

Get a Digital Twin Builder Flow example

Vzorová požiadavka

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/DigitalTwinBuilderFlows/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87

Vzorová odpoveď

Kód stavu:

200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "displayName": "DigitalTwinBuilderFlow 1",
  "description": "A Digital Twin Builder Flow description.",
  "type": "DigitalTwinBuilderFlow",
  "workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "properties": {
    "digitalTwinBuilderItemReference": {
      "referenceType": "ById",
      "itemId": "d96de2f4-7dd1-45ad-9ff6-37a2d6aa9861",
      "workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  }
}

Definície

Name	Description
DigitalTwinBuilderFlow	Digitálny objekt postupu Twin Builder.
DigitalTwinBuilderFlowProperties	Vlastnosti digital Twin Builder Flow.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
ItemReferenceById	Odkaz na položku podľa objektu ID.
ItemReferenceType	Typ odkazu na položku. V priebehu času je možné pridať ďalšie typy #D0.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

DigitalTwinBuilderFlow

Object

Digitálny objekt postupu Twin Builder.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný názov položky.
folderId	string (uuid)	ID priečinka.
id	string (uuid)	ID položky.
properties	DigitalTwinBuilderFlowProperties	Vlastnosti digital Twin Builder Flow.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovného priestoru.

DigitalTwinBuilderFlowProperties

Object

Vlastnosti digital Twin Builder Flow.

Name	Typ	Description
digitalTwinBuilderItemReference	ItemReference: ItemReferenceById	Odkaz na položku Digital Twin Builder.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

ItemReferenceById

Object

Odkaz na položku podľa objektu ID.

Name	Typ	Description
itemId	string (uuid)	ID položky.
referenceType	string: ById	Typ odkazu na položku.
workspaceId	string (uuid)	ID pracovného priestoru položky.

ItemReferenceType

Enumerácia

Typ odkazu na položku. V priebehu času je možné pridať ďalšie typy #D0.

Hodnota	Description
ById	Na položku odkazuje jej ID.

ItemTag

Object

Predstavuje značku použitú na položke.

Name	Typ	Description
displayName	string	Názov značky.
id	string (uuid)	ID značky.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Kopírovať úlohu.
Dashboard	Tabuľa služby PowerBI.
DataPipeline	Kanál údajov.
Dataflow	Tok údajov.
Datamart	Údajový diagram služby PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
Environment	Prostredie.
Eventhouse	Eventhouse.
Eventstream	Udalosť eventstream.
GraphQLApi	Rozhranie API pre položku GraphQL.
KQLDashboard	Tabuľa KQL.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
Lakehouse	Jazero.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
MirroredDatabase	Zrkadlová databáza.
MirroredWarehouse	Zrkadlový sklad.
MountedDataFactory	A MountedDataFactory.
Notebook	Poznámkový blok.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Reflex	A Reflex.
Report	Zostava PowerBI.
SQLDatabase	Databáza SQLDatabase.
SQLEndpoint	Koncový bod SQL.
SemanticModel	Sémantický model PowerBI.
SparkJobDefinition	Definícia úlohy iskry.
VariableLibrary	A VariableLibrary.
Warehouse	Sklad.
WarehouseSnapshot	Snímka skladu.