Get Pump
Get a list of all Pumps and Valves.
Response Body
| Name | Type | Description |
|---|---|---|
ID |
String |
Unique ID of the Pump or Valve. |
Name |
String |
Name of the Pump or Valve. |
ClassName |
String |
Class Name of the Pump or Valve. |
ColorSlot |
Object |
Color/Decoration information about the Actor. |
PrimaryColor |
String |
Hex Code of Primary Color |
SecondaryColor |
String |
Hex Code of Secondary Color |
BoundingBox |
Object |
Bounding Box information about the Actor. |
min |
Object |
The minimum boundary of the bounding box in the corresponding axis. |
x |
Float |
Value along the X-axis. |
y |
Float |
Value along the Y-axis. |
z |
Float |
Value along the Z-axis. |
max |
Object |
The maximum boundary of the bounding box in the corresponding axis. |
x |
Float |
Value along the X-axis. |
y |
Float |
Value along the Y-axis. |
z |
Float |
Value along the Z-axis. |
PowerInfo |
Object |
Power Information Object. |
CircuitGroupID |
Integer |
The group this circuit belongs too. (-1 = not connected) |
CircuitID |
Integer |
This circuit’s unique identifier. (-1 = not connected) |
FuseTriggered |
Boolean |
Has the fuse tripped? |
PowerConsumed |
Float |
Current power consumption. |
MaxPowerConsumed |
Float |
Current maximum power consumption. |
features |
Object |
An object with actor coordinates and name information. |
properties |
Object |
Name information about the actor. |
name |
String |
Display Name of the Actor. |
type |
String |
Type of the Object. |
geometry |
Object |
Geometry information about the Actor. |
coordinates |
Object |
The Actor coordinates. |
x |
Float |
X Location of the Actor. |
y |
Float |
Y Location of the Actor. |
z |
Float |
Z Location of the Actor. |
type |
String |
It’s always "Point". |
Example Response
[
{
"ID": "Build_PipelinePump_C_2146879650",
"Name": "Pipeline Pump Mk.1",
"ClassName": "Build_PipelinePump_C",
"location": {
"x": -5286.63427734375,
"y": 48738.54296875,
"z": 26675,
"rotation": 0.191588392598305
},
"BoundingBox": {
"min": {
"x": -5454.63427734375,
"y": 48678.54296875,
"z": 26615
},
"max": {
"x": -5074.63427734375,
"y": 48798.54296875,
"z": 26735
}
},
"ColorSlot": {
"PrimaryColor": "FA954900",
"SecondaryColor": "FA954900"
},
"PowerInfo": {
"CircuitGroupID": -1,
"CircuitID": -1,
"PowerConsumed": 0,
"MaxPowerConsumed": 0
}
}
]