Get Pipes

Get a list of all Pipes.

URL

GET http://localhost:8080/getPipes

Response Body

Name Type Description

ID

String

Unique ID of the Pipe.

Name

String

Name of the Pipe Type.

ClassName

String

Class Name of the Pipe.

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.

SplineData

Object

Spline Information for Actor.

  x

Float

Value along the X-axis.

  y

Float

Value along the Y-axis.

  z

Float

Value along the Z-axis.

location0

Object

Start Location of the Pipe

  x

Float

X Location in the World.

  y

Float

Y Location in the World.

  z

Float

Z Location in the World.

Connected0

Boolean

Is Pipe Connected at starting point?

location1

Object

End Location of the Pipe

  x

Float

X Location in the World.

  y

Float

Y Location in the World.

  z

Float

Z Location in the World.

Connected1

Boolean

Is Pipe Connected at ending point?

Length

Float

Length of the Pipe in centimetre (cm).

ItemsPerMinute

Float

Speed of the Pipe.

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_Pipeline_C_2146289486",
    "Name": "Pipeline Mk.1",
    "ClassName": "Build_Pipeline_C",
    "location": {
      "x": -279675.15625,
      "y": -150033.5,
      "z": -1513.14123535156,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": -279675.15625,
        "y": -150033.5,
        "z": -1513.14123535156
      },
      "max": {
        "x": -279675.15625,
        "y": -150033.5,
        "z": -1513.14123535156
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "FA954900"
    },
    "SplineData": [
      {
        "x": -279675.15625,
        "y": -150033.5,
        "z": -1513.14123535156
      },
      {
        "x": -279675.455968669,
        "y": -150133.499550843,
        "z": -1513.14123535156
      },
      {
        "x": -279675.455968669,
        "y": -150133.499550843,
        "z": -1513.14123535156
      },
      {
        "x": -279676.677520446,
        "y": -150541.06384952,
        "z": -1435.00002617008
      },
      {
        "x": -279776.911449535,
        "y": -150640.763856185,
        "z": -1435.00002617008
      },
      {
        "x": -281765.400404549,
        "y": -150636.103274844,
        "z": -1435.00002617008
      },
      {
        "x": -281765.63476251,
        "y": -150636.103000226,
        "z": -1435.00002617008
      },
      {
        "x": -281865.63476251,
        "y": -150636.103000226,
        "z": -1435.00002617008
      }
    ],
    "location0": {
      "x": -279675.15625,
      "y": -150033.5,
      "z": -1513.14123535156
    },
    "Connected0": true,
    "location1": {
      "x": -281865.63476251,
      "y": -150636.103000226,
      "z": -1435.00002617008
    },
    "Connected1": true,
    "Length": 2761.6640625,
    "Speed": 5,
    "features": {
      "properties": {
        "name": "Pipeline Mk.1",
        "type": "Pipeline Mk.1"
      },
      "geometry": {
        "coordinates": {
          "x": -279675.15625,
          "y": -150033.5,
          "z": -1513.14123535156
        },
        "type": "Point"
      }
    }
  }
]