Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId
and propertyId
of an asset property.
A propertyAlias
, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException
error.
For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}
, then storing {T1, GOOD, V2}
replaces the existing TQV.
AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue
entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
POST /properties HTTP/1.1
Content-type: application/json
{
"enablePartialEntryProcessing": boolean
,
"entries": [
{
"assetId": "string
",
"entryId": "string
",
"propertyAlias": "string
",
"propertyId": "string
",
"propertyValues": [
{
"quality": "string
",
"timestamp": {
"offsetInNanos": number
,
"timeInSeconds": number
},
"value": {
"booleanValue": boolean
,
"doubleValue": number
,
"integerValue": number
,
"nullValue": {
"valueType": "string
"
},
"stringValue": "string
"
}
}
]
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
This setting enables partial ingestion at entry-level. If set to true
, we ingest all TQVs not resulting in an error. If set to false
, an invalid TQV fails ingestion of the entire entry that contains it.
Type: Boolean
Required: No
The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
Type: Array of PutAssetPropertyValueEntry objects
Required: Yes
HTTP/1.1 200
Content-type: application/json
{
"errorEntries": [
{
"entryId": "string",
"errors": [
{
"errorCode": "string",
"errorMessage": "string",
"timestamps": [
{
"offsetInNanos": number,
"timeInSeconds": number
}
]
}
]
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ErrorsFor information about the errors that are common to all actions, see Common Errors.
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 409
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
HTTP Status Code: 400
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 410
The requested resource can't be found.
HTTP Status Code: 404
The requested service is unavailable.
HTTP Status Code: 503
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
HTTP Status Code: 429
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4