Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchPutPropertyValues

Sets values for multiple time series properties.

Request Syntax


POST /workspaces/workspaceId/entity-properties HTTP/1.1
Content-type: application/json

{
   "entries": [ 
      { 
         "entityPropertyReference": { 
            "componentName": "string",
            "componentPath": "string",
            "entityId": "string",
            "externalIdProperty": { 
               "string" : "string" 
            },
            "propertyName": "string"
         },
         "propertyValues": [ 
            { 
               "time": "string",
               "timestamp": number,
               "value": { 
                  "booleanValue": boolean,
                  "doubleValue": number,
                  "expression": "string",
                  "integerValue": number,
                  "listValue": [ 
                     "DataValue"
                  ],
                  "longValue": number,
                  "mapValue": { 
                     "string" : "DataValue"
                  },
                  "relationshipValue": { 
                     "targetComponentName": "string",
                     "targetEntityId": "string"
                  },
                  "stringValue": "string"
               }
            }
         ]
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace that contains the properties to set.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

entries

An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.

Type: Array of PropertyValueEntry objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errorEntries": [ 
      { 
         "errors": [ 
            { 
               "entry": { 
                  "entityPropertyReference": { 
                     "componentName": "string",
                     "componentPath": "string",
                     "entityId": "string",
                     "externalIdProperty": { 
                        "string" : "string" 
                     },
                     "propertyName": "string"
                  },
                  "propertyValues": [ 
                     { 
                        "time": "string",
                        "timestamp": number,
                        "value": { 
                           "booleanValue": boolean,
                           "doubleValue": number,
                           "expression": "string",
                           "integerValue": number,
                           "listValue": [ 
                              "DataValue"
                           ],
                           "longValue": number,
                           "mapValue": { 
                              "string" : "DataValue"
                           },
                           "relationshipValue": { 
                              "targetComponentName": "string",
                              "targetEntityId": "string"
                           },
                           "stringValue": "string"
                        }
                     }
                  ]
               },
               "errorCode": "string",
               "errorMessage": "string"
            }
         ]
      }
   ]
}

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.

errorEntries

Entries that caused errors in the batch put operation.

Type: Array of BatchPutPropertyErrorEntry objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

Failed

HTTP Status Code: 400