Dela via

Definition av digital tvillingbyggare

Den här artikeln innehåller en uppdelning av strukturen för definitionsobjekt för digital tvillingbyggare.

Format som stöds

DigitalTwinBuilder-objekt stöder JSON-formatet.

Definitionsdelar

I den här tabellen visas definitionsdelarna för digital tvillingbyggare.

Definitionsdelssökväg Typ Krävs Beskrivning
definition.json DefinitionDetails (JSON) sann Beskriver den LakehouseId associerade med objektet.
.platform PlatformDetails (JSON) falskt Beskriver vanlig information om objektet.
EntityTypes Katalog falskt Innehåller en lista över filer av entitetstyp som ingår i objektet. Varje entitetstypfil (JSON) beskriver information om entitetstypen.
EntityTypeRelationships Katalog falskt Innehåller en lista över relationsfiler av entitetstyp som ingår i objektet. Varje entitetstyprelationsfil (JSON) beskriver information om entitetstyprelationen.
ContextualizationOperations Katalog falskt Innehåller en lista över kontextualiseringsåtgärdsfiler som ingår i objektet. Varje kontextualiseringsåtgärdsfil (JSON) beskriver information om kontextualiseringsåtgärden.
MappingOperations Katalog falskt Innehåller en lista över mappningsåtgärdsfiler som ingår i objektet. Varje mappningsåtgärdsfil (JSON) beskriver information om mappningsåtgärden.

Definitionsexempel

{
  "parts": [
    {
      "path": "definition.json",
      "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
      "payloadType": "InlineBase64"
    },
    {
      "path": ".platform",
      "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
      "payloadType": "InlineBase64"
    }
  ]
}

Definitionsexempel med valfria definitionsdelar

{
  "parts": [
    {
      "path": "definition.json",
      "payload": "eyAKICAiTGFrZWhvdXNlSWQiOiAiMjIzMDE0NGItZjQ4Ni04YjZmLTQ5NmMtM2U4ZTI4NzZhYTBkIiwgICAKfSA=",
      "payloadType": "InlineBase64"
    },
    {
      "path": ".platform",
      "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
      "payloadType": "InlineBase64"
    },
    {
      "path": "EntityTypes/139950578358348.json",
      "payload": "ew0KICAiSWQiOiAiMTM5OTUwNTc4MzU4MzQ4IiwNCiAgIk5hbWVzcGFjZSI6ICJ1c2VydHlwZXMiLA0KICAiQmFzZUVudGl0eVR5cGVJZCI6ICIyIiwNCiAgIk5hbWUiOiAiRXF1aXBtZW50MSIsDQogICJQcm9wZXJ0aWVzIjogWw0KICAgIHsNCiAgICAgICJJZCI6ICI5MTcxODAxMTAzMjkyNjk0NTI4IiwNCiAgICAgICJOYW1lIjogIkRpc3BsYXlOYW1lIiwNCiAgICAgICJWYWx1ZVR5cGUiOiAiU3RyaW5nIg0KICAgIH0sDQogICAgew0KICAgICAgIklkIjogIjkxNzE4MDExMDMyOTI2OTQ1MjkiLA0KICAgICAgIk5hbWUiOiAiU2VyaWFsTnVtYmVyIiwNCiAgICAgICJWYWx1ZVR5cGUiOiAiU3RyaW5nIg0KICAgIH0sDQogICAgew0KICAgICAgIklkIjogIjkxNzE4MDExMDMyOTI2OTQ1MzAiLA0KICAgICAgIk5hbWUiOiAiTWFudWZhY3R1cmVyIiwNCiAgICAgICJWYWx1ZVR5cGUiOiAiU3RyaW5nIg0KICAgIH0NCiAgXSwNCiAgIlRpbWVzZXJpZXNQcm9wZXJ0aWVzIjogW10NCn0=",
      "payloadType": "InlineBase64"
    },
    {
      "path": "EntityTypes/31864156952988.json",
      "payload": "ew0KICAiSWQiOiAiMzE4NjQxNTY5NTI5ODgiLA0KICAiTmFtZXNwYWNlIjogInVzZXJ0eXBlcyIsDQogICJCYXNlRW50aXR5VHlwZUlkIjogIjIiLA0KICAiTmFtZSI6ICJFcXVpcG1lbnQyIiwNCiAgIlByb3BlcnRpZXMiOiBbDQogICAgew0KICAgICAgIklkIjogIjIwODgyNDkzOTAwNzEwMjE1NjgiLA0KICAgICAgIk5hbWUiOiAiRGlzcGxheU5hbWUiLA0KICAgICAgIlZhbHVlVHlwZSI6ICJTdHJpbmciDQogICAgfSwNCiAgICB7DQogICAgICAiSWQiOiAiMjA4ODI0OTM5MDA3MTAyMTU2OSIsDQogICAgICAiTmFtZSI6ICJTZXJpYWxOdW1iZXIiLA0KICAgICAgIlZhbHVlVHlwZSI6ICJTdHJpbmciDQogICAgfSwNCiAgICB7DQogICAgICAiSWQiOiAiMjA4ODI0OTM5MDA3MTAyMTU3MCIsDQogICAgICAiTmFtZSI6ICJNYW51ZmFjdHVyZXIiLA0KICAgICAgIlZhbHVlVHlwZSI6ICJTdHJpbmciDQogICAgfQ0KICBdLA0KICAiVGltZXNlcmllc1Byb3BlcnRpZXMiOiBbXQ0KfQ==",
      "payloadType": "InlineBase64"
    },
    {
      "path": "EntityTypeRelationships/95745415684647936.json",
      "payload": "ew0KICAiSWQiOiAiOTU3NDU0MTU2ODQ2NDc5MzYiLA0KICAiTmFtZXNwYWNlIjogInVzZXJ0eXBlcyIsDQogICJSZWxhdGlvbnNoaXBDYXJkaW5hbGl0eSI6ICJNYW55VG9PbmUiLA0KICAiTmFtZSI6ICJjb250YWlucyIsDQogICJGaXJzdEVudGl0eVR5cGVJZCI6ICIzMTg2NDE1Njk1Mjk4OCIsDQogICJTZWNvbmRFbnRpdHlUeXBlSWQiOiAiMTM5OTUwNTc4MzU4MzQ4Ig0KfQ==",
      "payloadType": "InlineBase64"
    },
    {
      "path": "ContextualizationOperations/30f6380c-9643-4284-a5bd-f100ac08866f.json",
      "payload": "ewogICJPcGVyYXRpb25JZCI6ICIzMGY2MzgwYy05NjQzLTQyODQtYTViZC1mMTAwYWMwODg2NmYiLAogICJEaXNwbGF5TmFtZSI6ICJFcXVpcG1lbnQyX2NvbnRhaW5zX0VxdWlwbWVudDFfQ29udGV4dHVhbGl6YXRpb24iLAogICJPcGVyYXRpb25UeXBlIjogIkNvbnRleHR1YWxpemF0aW9uIiwKICAiRW50aXR5VHlwZVJlbGF0aW9uc2hpcElkIjogIjk1NzQ1NDE1Njg0NjQ3OTM2IiwKICAiSm9pbkNvbHVtbnMiOiB7CiAgICAiRmlyc3RDb2x1bW4iOiB7CiAgICAgICJFbnRpdHlJZCI6ICIzMTg2NDE1Njk1Mjk4OCIsCiAgICAgICJBdHRyaWJ1dGVOYW1lIjogIlNlcmlhbE51bWJlciIKICAgIH0sCiAgICAiU2Vjb25kQ29sdW1uIjogewogICAgICAiRW50aXR5SWQiOiAiMTM5OTUwNTc4MzU4MzQ4IiwKICAgICAgIkF0dHJpYnV0ZU5hbWUiOiAiU2VyaWFsTnVtYmVyIgogICAgfQogIH0KfQ==",
      "payloadType": "InlineBase64"
    },
    {
      "path": "MappingOperations/ce9d0ef9-d8f6-4391-9e37-8bdb91b1fc16.json",
      "payload": "ewogICJPcGVyYXRpb25JZCI6ICJjZTlkMGVmOS1kOGY2LTQzOTEtOWUzNy04YmRiOTFiMWZjMTYiLAogICJEaXNwbGF5TmFtZSI6ICJFcXVpcG1lbnQxX2VudGl0eXR5cGUiLAogICJPcGVyYXRpb25UeXBlIjogIk1hcHBpbmciLAogICJFbnRpdHlUeXBlSWQiOiAiMTM5OTUwNTc4MzU4MzQ4IiwKICAiTWFwcGluZ09wZXJhdGlvblByb3BlcnRpZXMiOiB7CiAgICAiTWFwcGluZ1R5cGUiOiAiTm9uVGltZVNlcmllcyIsCiAgICAiTWFwcGVkUHJvcGVydGllcyI6IFsKICAgICAgewogICAgICAgICJTb3VyY2VDb2x1bW4iOiAiTmFtZSIsCiAgICAgICAgIkVudGl0eVR5cGVQcm9wZXJ0eU5hbWUiOiAiRGlzcGxheU5hbWUiCiAgICAgIH0KICAgIF0sCiAgICAiUHJvY2Vzc2luZ1R5cGUiOiAiSXRlcmF0aXZlIiwKICAgICJFbnRpdHlJbnN0YW5jZUlkU2NoZW1hIjogWwogICAgICAiSWQiCiAgICBdLAogICAgIlRpbWVzZXJpZXNFbnRpdHlMaW5rUHJvcGVydGllcyI6IG51bGwKICB9LAogICJTb3VyY2VUYWJsZVByb3BlcnRpZXMiOiB7CiAgICAiU291cmNlVHlwZSI6ICJMYWtlaG91c2VUYWJsZXMiLAogICAgIldvcmtzcGFjZUlkIjogImFlMzU5YmI4LTJmZmEtNGUzZi1hMGI1LTJmOGJjZWVmNmQyOSIsCiAgICAiSXRlbUlkIjogIjU5ZTViMDk4LWYzZDMtNDViNi1hY2RkLWQ3ZjRjOTZjNmNjZCIsCiAgICAiU291cmNlVGFibGVOYW1lIjogImVudGl0eXR5cGUiLAogICAgIlNvdXJjZVNjaGVtYSI6IG51bGwKICB9LAogICJGaWx0ZXJzIjogbnVsbAp9",
      "payloadType": "InlineBase64"
    }
  ]
}

DefinitionDetails

Fastighet Typ Krävs Beskrivning
LakehouseId Guide sann Objekt-ID för det överordnade sjöhuset som finns på arbetsytan.

Det går inte att ta bort lakehouse om DigitalTwinBuilder fortfarande finns.

Exempel på definitionsfil

{ 

  "LakehouseId": "2230144b-f486-8b6f-496c-3e8e2876aa0d"   

}

PlatformDetails

Plattformsdelen är en fil som innehåller information om miljömetadata.

  • Create Item med definition respekterar plattformsfilen om den tillhandahålls
  • Get Item definition returnerar alltid plattformsfilen.
  • Update Item definition accepterar plattformsfilen om den tillhandahålls, men bara om du anger en ny URL-parameter updateMetadata=true.

EntityTypes-katalog: EntityType-fil

EntityType-filnamnet är entitetstypens ID.

Fastighet Typ Krävs Beskrivning
Id BigInt sann Unikt ID för entitetstypen. Det här värdet är alltid större än 10 000.
Namespace snöre sann Namnområde för entitetstypen. Tillåtet värde: usertypes.
BaseEntityTypeId BigInt sann Unikt ID för basentitetstypen.
Name snöre sann Namnet på entitetstypen.
Properties EntityTypeProperty[] sann Lista över egenskaper för entitetstyp.
TimeseriesProperties EntityTypeProperty[] sann Lista över egenskaper för entitetstyp.

EntityTypeProperty

Fastighet Typ Krävs Beskrivning
Id lång sann Unikt ID för egenskapen entitetstyp.
Name snöre sann Namnet på egenskapen entitetstyp.
ValueType snöre sann Beskriver värdetypen för egenskapen entitetstyp. Tillåtna värden: BigInt, Float, Double, String, Bool, DateTime.

EntityType-filexempel

{
  "Id": "139950578358348",
  "Namespace": "usertypes",
  "BaseEntityTypeId": "2",
  "Name": "Equipment1",
  "Properties": [
    { "Id": "9171801103292694528", "Name": "DisplayName", "ValueType": "String" },
    { "Id": "9171801103292694529", "Name": "SerialNumber", "ValueType": "String" },
    { "Id": "9171801103292694530", "Name": "Manufacturer", "ValueType": "String" }
  ],
  "TimeseriesProperties": []
}

EntityTypeRelationships-katalog: EntityTypeRelationship-fil

EntityTypeRelationship-filnamnet är relations-ID för entitetstyp.

Fastighet Typ Krävs Beskrivning
Id BigInt sann Unikt ID för entitetstyprelationen. Dess värde är alltid större än 10 000.
Namespace snöre sann Namnområde för entitetstyprelationen. Tillåtet värde: usertypes.
RelationshipCardinality BigInt sann Relationens kardinalitet för entitetstyprelationen. Tillåtna värden: ManyToOne, OneToMany.
Name snöre sann Namnet på entitetstypens relation.
FirstEntityTypeId BigInt sann Unikt ID för den första entitetstypen som finns på arbetsytan.
SecondEntityTypeId BigInt sann Unikt ID för den andra entitetstypen som finns på arbetsytan.

EntityTypeRelationship-filexempel

{
  "Id": "95745415684647936",
  "Namespace": "usertypes",
  "RelationshipCardinality": "ManyToOne",
  "Name": "contains",
  "FirstEntityTypeId": "31864156952988",
  "SecondEntityTypeId": "139950578358348"
}

Katalogen ContextualizationOperations: ContextualizationOperation-fil

Filnamnet ContextualizationOperation är kontextualiseringsåtgärdens ID. En ContextualizationOperation kan köras med hjälp av en DigitalTwinBuilderFlow-artefakt .

Fastighet Typ Krävs Beskrivning
OperationId Guide sann Unikt ID för kontextualiseringsåtgärden.
DisplayName snöre sann Visningsnamn för kontextualiseringsåtgärden.
OperationType snöre sann Åtgärdstyp. Tillåtet värde: Contextualization.
EntityTypeRelationshipId snöre sann Unikt ID för entitetstyprelationen som finns på arbetsytan.
JoinColumns JoinColumnsConfiguration sann Kopplingsinformation om entitetstyper.

JoinColumnsConfiguration

Fastighet Typ Krävs Beskrivning
FirstColumn JoinColumn sann Kopplingsinformation för den första entitetstypen som finns på arbetsytan.
SecondColumn JoinColumn sann Kopplingsinformation för den andra entitetstypen som finns på arbetsytan.

JoinColumn

Fastighet Typ Krävs Beskrivning
EntityId BigInt sann Unikt ID för entitetstypen.
AttributeName snöre sann Attributnamn för entitetstypen.

Exempel på kontextualiseringsåtgärdsfil

{
  "OperationId": "30f6380c-9643-4284-a5bd-f100ac08866f",
  "DisplayName": "Equipment2_contains_Equipment1_Contextualization",
  "OperationType": "Contextualization",
  "EntityTypeRelationshipId": "95745415684647936",
  "JoinColumns": {
    "FirstColumn": {
      "EntityId": "31864156952988",
      "AttributeName": "SerialNumber"
    },
    "SecondColumn": {
      "EntityId": "139950578358348",
      "AttributeName": "SerialNumber"
    }
  }
}

Directory MappingOperations: MappingOperation-fil

Filnamnet MappingOperation är mappningsåtgärdens ID. En MappingOperation kan köras med hjälp av en DigitalTwinBuilderFlow-artefakt .

Fastighet Typ Krävs Beskrivning
OperationId Guide sann Unikt ID för mappningsåtgärden.
DisplayName snöre sann Visningsnamn för mappningsåtgärden.
OperationType snöre sann Åtgärdstyp. Tillåtet värde: Mapping.
EntityTypeId snöre sann Unikt ID för den entitetstyp som finns på arbetsytan.
MappingOperationProperties MappingOperationProperties sann Modell som innehåller egenskaperna för en mappningsåtgärd.
SourceTableProperties SourceTableProperties sann Egenskaper för källtabellen.
Filters FilterOperationNode sann Filtrera objekt som används för att filtrera tabellkällans data. Tillåtna värden: FilterOperationNode kan vara null om det inte finns några filter som ska tillämpas, eller på annat sätt kan vara en ComparisonFilterOperationNode eller LogicalFilterOperationNode.

MappingOperationProperties

Fastighet Typ Krävs Beskrivning
MappingType snöre sann Tillåtna värden: non-timeseries, timeseries.
MappedProperties SourceColumnDefinition[] sann Kolumnmappningarna för källtabellen till måltabellen.
ProcessingType snöre sann Anger typen av bearbetning av mappningsåtgärden. Tillåtna värden: iterative, incremental.
EntityInstanceIdSchema sträng[] sann Gäller för egenskaper som inte är tidsserier. Lista över strängar som representerar källkolumnerna som utgör den unika identifieraren för en entitet.
TimeseriesEntityLinkProperties TimeseriesEntityLinkProperties sann Gäller för egenskaper för tidsserier. Källkolumnegenskapen som används för att länka entiteten till tidsseriedata.

SourceColumnDefinition

Fastighet Typ Krävs Beskrivning
SourceColumn snöre sann Namnet på källkolumnen.
EntityTypePropertyName snöre sann Anpassat namn som kunden har tilldelat egenskapen entitetstyp.

TimeseriesEntityLinkProperties

Fastighet Typ Krävs Beskrivning
EntityProperty snöre sann Entitetsegenskap som används för att länka entiteten till tidsseriedata.
TimeseriesProperty snöre sann Kolumn från tidseriedata som matchar värdena för entitetsegenskapen.

SourceTableProperties

Fastighet Typ Krävs Beskrivning
SourceType snöre sann Tillåtet värde: LakehouseTables.
WorkspaceId Guide sann Arbetsytan där kundens sjöhus finns.
ItemId Guide sann ArtifactId för kundens sjöhus.
SourceTableName snöre sann Det inmatade datatabellnamnet.
SourceSchema snöre sann Det inmatade datatabellschemat.

ComparisonFilterOperationNode

Fastighet Typ Krävs Beskrivning
type snöre sann Typ av filteråtgärd. Tillåtet värde: comparison.
SourceColumn snöre sann Källkolumnens namn på data som filtreras.
ComparisonOperatorKind snöre sann Representerar typen av jämförelseoperator för noden. Tillåtna värden: Ge, Gt, Le, Lt, Eq, NotEq, Contains, NotContains, IsNull, IsNotNull.
Value snöre sann Värde som används för att filtrera.
ValueType snöre sann Typ av värde som används för att filtrera. Tillåtna värden: BigInt, Float, Double, String, Bool, DateTime.

LogicalFilterOperationNode

Fastighet Typ Krävs Beskrivning
type snöre sann Typ av filteråtgärd. Tillåtet värde: logical.
LogicalOperatorKind snöre sann Representerar typen av logisk operator för noden. Tillåtna värden: And, Or.
FilterOperations FilterOperationNode[] sann Filteråtgärder som används av den logiska operatorn.

MappningOperations-filexempel

{
  "OperationId": "ce9d0ef9-d8f6-4391-9e37-8bdb91b1fc16",
  "DisplayName": "Equipment1_entitytype",
  "OperationType": "Mapping",
  "EntityTypeId": "139950578358348",
  "MappingOperationProperties": {
    "MappingType": "NonTimeSeries",
    "MappedProperties": [
      {
        "SourceColumn": "Name",
        "EntityTypePropertyName": "DisplayName"
      }
    ],
    "ProcessingType": "Iterative",
    "EntityInstanceIdSchema": ["Id"],
    "TimeseriesEntityLinkProperties": null
  },
  "SourceTableProperties": {
    "SourceType": "LakehouseTables",
    "WorkspaceId": "ae359bb8-2ffa-4e3f-a0b5-2f8bceef6d29",
    "ItemId": "59e5b098-f3d3-45b6-acdd-d7f4c96c6ccd",
    "SourceTableName": "entitytype",
    "SourceSchema": null
  },
  "Filters": {
    "type": "comparison",
    "SourceColumn": "Name",
    "ComparisonOperatorKind": "Contains",
    "Value": "abc",
    "ValueType": "String"
  }
}