get
/v1/config/site/actuators
https://platform.sitepro.com/v1/config/site/actuators
Get actuator configuration for a site
Expected responses
{ "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "actuator": { "type": "object", "properties": { "SiteActuatorID": { "type": "number", "example": 1 }, "SiteID": { "type": "number", "example": 789 }, "SiteActuatorStatusID": { "type": "number", "example": 3 }, "Name": { "type": "string", "example": "Tank Actuator" }, "SiteInOutDeviceID": { "type": "number", "example": null, "nullable": true }, "SiteModbusInOutDeviceID": { "type": "number", "example": 63, "nullable": true }, "FullyClosedChannel": { "type": "number", "example": 2 }, "FullyOpenChannel": { "type": "number", "example": 1 }, "CloseChannel": { "type": "number", "example": 2 }, "OpenChannel": { "type": "number", "example": 1 }, "DigitalInMissingAlarmActive": { "type": "boolean", "example": false }, "DigitalInMissingAlarmDescription": { "type": "string", "example": "" }, "Auto": { "type": "boolean", "example": false }, "LoggingEnabled": { "type": "boolean", "description": "Omitted from light responses", "example": true }, "UsesAnalogControl": { "type": "boolean", "example": false, "nullable": true }, "AnalogOutChannel": { "type": "number", "example": 3, "nullable": true }, "AnalogOutSiteModbusInOutDeviceID": { "type": "number", "example": 63, "nullable": true }, "AnalogInValvePositionChannel": { "type": "number", "example": 4, "nullable": true }, "AnalogInSiteModbusInOutDeviceID": { "type": "number", "example": 63, "nullable": true }, "FullyOpenPosition": { "type": "number", "example": 100, "nullable": true }, "FullyClosedPosition": { "type": "number", "example": 0, "nullable": true }, "DigitalOpenValveRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10231", "nullable": true }, "DigitalCloseValveRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10232", "nullable": true }, "DigitalFullyOpenValveRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10233", "nullable": true }, "DigitalFullyClosedValveRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10234", "nullable": true }, "AnalogOpenValveRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10235", "nullable": true }, "AnalogValvePositionRegisterID": { "type": "string", "description": "bigint serialized as string", "example": "10236", "nullable": true }, "AnalogValvePositionSensorID": { "type": "number", "example": 4321, "nullable": true }, "CurrentValvePosition": { "type": "number", "description": "Omitted from light responses", "example": 75, "nullable": true }, "LastClosed": { "type": "string", "description": "Omitted from light responses", "format": "date-time", "nullable": true }, "LastOpened": { "type": "string", "description": "Omitted from light responses", "format": "date-time", "nullable": true }, "ESDState": { "type": "number", "example": 0, "nullable": true }, "ESDCustomPosition": { "type": "number", "example": 0, "nullable": true }, "MonitorStatusIndicators": { "type": "boolean", "example": true, "nullable": true }, "MaxTimeToFullyOpen": { "type": "number", "example": 30, "nullable": true }, "MaxTimeToFullyClose": { "type": "number", "example": 30, "nullable": true }, "DefaultAction": { "type": "number", "example": 1, "nullable": true }, "DefaultPosition": { "type": "number", "example": 0, "nullable": true }, "Delete": { "type": "boolean", "example": false, "nullable": true }, "DesignTypeID": { "type": "number", "description": "Omitted from light responses", "example": 1, "nullable": true }, "Latitude": { "type": "number", "description": "Omitted from light responses", "example": 33.508, "nullable": true }, "Longitude": { "type": "number", "description": "Omitted from light responses", "example": -101.855, "nullable": true }, "CustomIconURL": { "type": "string", "description": "Omitted from light responses", "example": null, "nullable": true } }, "required": [ "SiteActuatorID", "SiteID", "SiteActuatorStatusID", "Name", "FullyClosedChannel", "FullyOpenChannel", "CloseChannel", "OpenChannel", "DigitalInMissingAlarmActive", "DigitalInMissingAlarmDescription", "Auto" ] }, "sensorScalings": { "type": "array", "items": { "type": "object", "properties": { "SiteActuatorSensorScalingID": { "type": "number", "example": 4 }, "SiteActuatorID": { "type": "number", "example": 1 }, "SiteSensorID": { "type": "number", "example": 3658 }, "Active": { "type": "boolean", "example": false }, "ScalePoints": { "description": "Parsed from the stored JSON; empty when unset or unparseable", "type": "array", "items": { "type": "object", "properties": { "F": { "type": "number", "description": "Actuator position (percent)", "example": 75 }, "V": { "type": "number", "description": "Sensor value", "example": 10 } }, "required": [ "F", "V" ] } } }, "required": [ "SiteActuatorSensorScalingID", "SiteActuatorID", "SiteSensorID", "Active", "ScalePoints" ] } }, "sensorTriggers": { "type": "array", "items": { "type": "object", "properties": { "SiteActuatorID": { "type": "number", "example": 1 }, "SiteSensorID": { "type": "number", "example": 25011 }, "TopAlarmActuatorAction": { "type": "number", "example": 2 }, "TopAlarmCustomPosition": { "type": "number", "example": 0 }, "BottomAlarmActuatorAction": { "type": "number", "example": 2 }, "BottomAlarmCustomPosition": { "type": "number", "example": 0 }, "TimeBased": { "type": "boolean", "example": false }, "TopAlarmActionActiveTime": { "type": "number", "example": 0, "nullable": true }, "TopAlarmActionInactiveTime": { "type": "number", "example": 0, "nullable": true }, "BottomAlarmActionActiveTime": { "type": "number", "example": 0, "nullable": true }, "BottomAlarmActionInactiveTime": { "type": "number", "example": 0, "nullable": true }, "Active": { "type": "boolean", "example": false } }, "required": [ "SiteActuatorID", "SiteSensorID", "TopAlarmActuatorAction", "TopAlarmCustomPosition", "BottomAlarmActuatorAction", "BottomAlarmCustomPosition", "TimeBased", "Active" ] } }, "tankGroupConnections": { "type": "array", "items": { "type": "object", "properties": { "SiteActuatorTankGroupConnectionID": { "type": "number", "example": 4 }, "SiteActuatorID": { "type": "number", "example": 1 }, "SiteTankGroupID": { "type": "number", "example": 836 }, "SiteMiddleTankID": { "type": "number", "example": 12, "nullable": true }, "LevelToOpen": { "type": "number", "example": 21 }, "LevelToClose": { "type": "number", "example": 22 }, "LevelToAlertClose": { "type": "number", "example": 21.5 }, "Active": { "type": "boolean", "example": false } }, "required": [ "SiteActuatorTankGroupConnectionID", "SiteActuatorID", "SiteTankGroupID", "LevelToOpen", "LevelToClose", "LevelToAlertClose", "Active" ] } } }, "required": [ "actuator", "sensorScalings", "sensorTriggers", "tankGroupConnections" ] } } } } }
Related schemas
curl -X GET -H "Authorization: Bearer <JWT_Token>" "https://platform.sitepro.com/v1/config/site/actuators"
Authorization
Bearer