Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
AWS IoT TwinMaker connecteurs de données
Les connecteurs doivent accéder à votre banque de données sous-jacente pour résoudre les requêtes envoyées et renvoyer des résultats ou une erreur.
Pour en savoir plus sur les connecteurs disponibles, leurs interfaces de demande et leurs interfaces de réponse, consultez les rubriques suivantes.
Pour plus d'informations sur les propriétés utilisées dans les interfaces de connecteur, consultez l'action GetPropertyValueHistoryAPI.
Note
Certains connecteurs comportent deux champs d'horodatage dans les interfaces de demande et de réponse pour les propriétés d'heure de début et de fin. Les deux startDateTime et endDateTime utilisez un nombre long pour représenter la seconde époque, ce qui n'est plus pris en charge. Pour garantir la rétrocompatibilité, nous envoyons toujours une valeur d'horodatage à ce champ, mais nous recommandons d'utiliser les endTime champs startTime et conformes au format d'horodatage de notre API.
Rubriques
Connecteur d'initialisation de schéma
Vous pouvez utiliser l'initialiseur de schéma dans le type de composant ou le cycle de vie de l'entité pour récupérer le type de composant ou les propriétés du composant à partir de la source de données sous-jacente. L'initialiseur de schéma importe automatiquement le type ou les propriétés des composants sans appeler explicitement une action d'API à configurer. properties
SchemaInitializer interface de demande
{ "workspaceId": "string", "entityId": "string", "componentName": "string", "properties": { // property name as key, // value is of type PropertyRequest "string": "PropertyRequest" } }
Note
La carte des propriétés de cette interface de demande est unPropertyRequest. Pour plus d'informations, consultez PropertyRequest.
SchemaInitializer interface de réponse
{ "properties": { // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" } }
Note
La carte des propriétés de cette interface de demande est unPropertyResponse. Pour plus d'informations, consultez PropertyResponse.
DataReaderByEntity
DataReaderByEntity est un connecteur de plan de données utilisé pour obtenir les valeurs chronologiques des propriétés d'un seul composant.
Pour plus d'informations sur les types de propriétés, la syntaxe et le format de ce connecteur, consultez l'action GetPropertyValueHistoryAPI.
DataReaderByEntityinterface de demande
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "entityId": "string", "componentName": "string", "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReaderByEntityinterface de réponse
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
DataReaderByComponentType
Pour obtenir les valeurs chronologiques des propriétés communes issues du même type de composant, utilisez le connecteur DataReaderByEntity de plan de données. Par exemple, si vous définissez des propriétés de séries chronologiques dans le type de composant et que plusieurs composants utilisent ce type de composant, vous pouvez interroger ces propriétés pour tous les composants d'une plage de temps donnée. C'est un cas d'utilisation courant lorsque vous souhaitez interroger l'état d'alarme de plusieurs composants pour obtenir une vue globale de vos entités.
Pour plus d'informations sur les types de propriétés, la syntaxe et le format de ce connecteur, consultez l'action GetPropertyValueHistoryAPI.
DataReaderByComponentType interface de demande
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReaderByComponentType interface de réponse
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "entityId": "string", "componentName": "string", "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
DataReader
DataReader est un connecteur de plan de données capable de gérer à la fois le cas de DataReaderByEntity et DataReaderByComponentType.
Pour plus d'informations sur les types de propriétés, la syntaxe et le format de ce connecteur, consultez l'action GetPropertyValueHistoryAPI.
DataReader interface de demande
La EntityId et l'componentName sont facultatifs.
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyRequest "string": "PropertyRequest" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "entityId": "string", "componentName": "string", "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReader interface de réponse
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
AttributePropertyValueReaderByEntity
AttributePropertyValueReaderByEntity est un connecteur de plan de données que vous pouvez utiliser pour récupérer la valeur des propriétés statiques d'une seule entité.
Pour plus d'informations sur les types de propriétés, la syntaxe et le format de ce connecteur, consultez l'action GetPropertyValueAPI.
AttributePropertyValueReaderByEntity interface de demande
{ "properties": { // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" } "workspaceId": "string", "entityId": "string", "componentName": "string", "selectedProperties": List:"string", }
AttributePropertyValueReaderByEntity interface de réponse
{ "propertyValues": { "string": { // property name as key "propertyReference": EntityPropertyReference, // The same as EntityPropertyReference "propertyValue": DataValue // The same as DataValue } }
DataWriter
DataWriter est un connecteur de plan de données que vous pouvez utiliser pour réécrire des points de données de séries chronologiques dans le magasin de données sous-jacent pour les propriétés d'un seul composant.
Pour plus d'informations sur les types de propriétés, la syntaxe et le format de ce connecteur, consultez l'action BatchPutPropertyValuesAPI.
DataWriter interface de demande
{ "workspaceId": "string", "properties": { // entity id as key "String": { // property name as key, // value is of type PropertyResponse "string": PropertyResponse } }, "entries": [ { "entryId": "string", "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "propertyValues": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ] }
DataWriter interface de réponse
{ "errorEntries": [ { "errors": List:BatchPutPropertyError // The value is a list of type BatchPutPropertyError } ] }
Exemples
Les exemples JSON suivants sont des exemples de syntaxe de réponse et de demande pour plusieurs connecteurs.
-
SchemaInitializer:
Les exemples suivants montrent l'initialiseur de schéma dans le cycle de vie d'un type de composant.
Requête :
{ "workspaceId": "myWorkspace", "properties": { "modelId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false, "defaultValue": { "stringValue": "myModelId" } }, "value": { "stringValue": "myModelId" } }, "tableName": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": false, "defaultValue": { "stringValue": "myTableName" } }, "value": { "stringValue": "myTableName" } } } }Réponse :
{ "properties": { "myProperty1": { "definition": { "dataType": { "type": "DOUBLE", "unitOfMeasure": "%" }, "configuration": { "myProperty1Id": "idValue" }, "isTimeSeries": true } }, "myProperty2": { "definition": { "dataType": { "type": "STRING" }, "isTimeSeries": false, "defaultValue": { "stringValue": "property2Value" } } } } } -
Initialiseur de schéma dans le cycle de vie des entités :
Requête :
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "tableName": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myTableName" } } } }Réponse :
{ "properties": { "myProperty1": { "definition": { "dataType": { "type": "DOUBLE", "unitOfMeasure": "%" }, "configuration": { "myProperty1Id": "idValue" }, "isTimeSeries": true } }, "myProperty2": { "definition": { "dataType": { "type": "STRING" }, "isTimeSeries": false }, "value": { "stringValue": "property2Value" } } } } -
DataReaderByEntity et DataReader :
Requête :
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "selectedProperties": [ "Temperature", "Pressure" ], "startTime": "2022-04-07T04:04:42Z", "endTime": "2022-04-07T04:04:45Z", "maxResults": 4, "orderByTime": "ASCENDING", "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "Temperature": { "definition": { "configuration": { "temperatureId": "xyz123" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "DEGC" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } }, "Pressure": { "definition": { "configuration": { "pressureId": "xyz456" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "MPA" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } } } }Réponse :
{ "propertyValues": [ { "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "values": [ { "time": "2022-04-07T04:04:42Z", "value": { "doubleValue": 588.168 } }, { "time": "2022-04-07T04:04:43Z", "value": { "doubleValue": 592.4224 } } ] } ], "nextToken": "qwertyuiop" } -
AttributePropertyValueReaderByEntity:
Requête :
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "selectedProperties": [ "manufacturer", ], "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "manufacturer": { "definition": { "dataType": { "type": "STRING" }, "configuration": { "manufacturerPropId": "M001" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": true, "isTimeSeries": false } } } }Réponse :
{ "propertyValues": { "manufacturer": { "propertyReference": { "propertyName": "manufacturer", "entityId": "myEntity", "componentName": "myComponent" }, "propertyValue": { "stringValue": "Amazon" } } } } -
DataWriter:
Requête :
{ "workspaceId": "myWorkspaceId", "properties": { "myEntity": { "Temperature": { "definition": { "configuration": { "temperatureId": "xyz123" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "DEGC" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } } } }, "entries": [ { "entryId": "myEntity", "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "propertyValues": [ { "timestamp": 1626201120, "value": { "doubleValue": 95.6958 } }, { "timestamp": 1626201132, "value": { "doubleValue": 80.6959 } } ] } ] }Réponse :
{ "errorEntries": [ { "errors": [ { "errorCode": "409", "errorMessage": "Conflict value at same timestamp", "entry": { "entryId": "myEntity", "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "propertyValues": [ "time": "2022-04-07T04:04:42Z", "value": { "doubleValue": 95.6958 } ] } } ] } ] }
