Skip to main content Skip to footer

Array Property Pick Documentation

Version: 1.0.0 
Retrieved: 2025-10-09 15:15:12


Array Property Pick

Picks Properties to Keep from all objects in Source Property and creates a new array of objects with only the picked properties, and writes the result to Target Property.

Note

  • If object is missing a property in Properties to Keep, null is used as value for that property.

Possible errors

If the value of Source Property is not an array of objects, the module will warn and will not send a message to modules connected to it.

Settings

Name Requirements Purpose Default
Source property String 1-64 in length The property containing the object to convert data
Target property String 1-64 in length The property to write the array to data
Properties to Keep List of strings The properties to keep data

Example

# Settings:
Source Property = data
Target Property = data
Properties to Keep = ["key", "temperature"]

# Incoming messages:
{
  "data": [
    {
        "key": "sensor_1",
        "temperature": 31.1,
        "location": [10, 11]
    },
    {
        "key": "sensor_2",
        "temperature": 32.2,
        "location": [12, 13]
    },
    {
        "key": "sensor_3",
        "location": [14, 15]
    },
    {
        "key": "sensor_4",
        "temperature": 34.4,
        "location": [16, 17]
    }
  ]
}

# Outgoing message:
{
  "data": [
    {
        "key": "sensor_1",
        "temperature": 31.1
    },
    {
        "key": "sensor_2",
        "temperature": 32.2
    },
    {
        "key": "sensor_3",
        "temperature": null
    },
    {
        "key": "sensor_4",
        "temperature": 34.4
    }
  ]
}

NOTE:

  • Null is used as value for all properties in Property to Keep that is missing on object.
  • The order of the objects are kept from input.