Get modeling data
  • 17 Jan 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get modeling data

  • Dark
    Light
  • PDF

Article summary

Get
/modeling/data/{taskId}/

Get the generated modeling data

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
taskId
string (uuid) Required

Id of the modeling data task

Responses
200

Modeling data

{
  "analysis": "constantflow",
  "lat": 62.31975545323489,
  "lon": 23.235615860470666,
  "setting": [
    null,
    null,
    null,
    "44",
    "33",
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ],
  "type": "fireflow"
}
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          "25.77711559168105",
          "62.35467439977987",
          "0"
        ],
        "type": "Point"
      },
      "properties": {
        "consumer_number": "2222",
        "critical_customer": null,
        "flowmeters": [
          {
            "class": "Not defined",
            "consumption_estimate": 55,
            "number": "123456",
            "size": null,
            "type": "Not defined"
          }
        ],
        "id": 22111,
        "identification": "",
        "residents": null,
        "sprinkler_customer": null,
        "type": "Residential",
        "water_connection": null
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}
[
  {
    "clock": "7",
    "flow_amount": "100",
    "id": 118689604,
    "node_id": 123335,
    "pressure_limit": "2024-04-02T00:00:00Z",
    "start_limit": "4",
    "stop_limit": "2024-07-08T00:00:00Z",
    "type": "flow"
  },
  {
    "clock": "17",
    "flow_amount": "34.5",
    "id": 108465988,
    "node_id": 123335,
    "pressure_limit": "2024-04-04T00:00:00Z",
    "start_limit": "5",
    "stop_limit": "2024-07-02T00:00:00Z",
    "type": "flow"
  },
  {
    "clock": "22",
    "flow_amount": "34.5",
    "id": 120655684,
    "node_id": 123335,
    "pressure_limit": "2024-04-06T00:00:00Z",
    "start_limit": "5",
    "stop_limit": "2024-07-02T00:00:00Z",
    "type": "flow"
  },
  {
    "clock": "",
    "id": 113053508,
    "max_flow": "20",
    "max_level": "2024-02-02T00:00:00Z",
    "min_flow": "0.001",
    "min_level": "1",
    "node_id": 108429,
    "type": "lvlcmp"
  }
]
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          "22.74968994143649",
          "62.33005465890707",
          "77.54"
        ],
        "type": "Point"
      },
      "properties": {
        "id": 123337,
        "linked_duct_id": null,
        "main_type": "Water node",
        "status": "Open",
        "sub_type": "Main duct valve"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          "22.7685276864659",
          "62.4093290366945",
          "143.9600001"
        ],
        "type": "Point"
      },
      "properties": {
        "id": 123335,
        "linked_duct_id": null,
        "main_type": "Water node",
        "status": null,
        "sub_type": "Upper water tank"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          "22.79582762976401",
          "62.354954514496775",
          "88.6700001"
        ],
        "type": "Point"
      },
      "properties": {
        "id": 108429,
        "linked_duct_id": null,
        "main_type": "Water node",
        "status": null,
        "sub_type": "Pumping station"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          "22.749776543400504",
          "62.33094367738102",
          "81.14"
        ],
        "type": "Point"
      },
      "properties": {
        "id": 123336,
        "linked_duct_id": null,
        "main_type": "Water node",
        "status": null,
        "sub_type": "Splice"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          "23.235615860470666",
          "62.31975545323489",
          "0"
        ],
        "type": "Point"
      },
      "properties": {
        "id": 145450,
        "linked_duct_id": null,
        "main_type": "Water node",
        "status": null,
        "sub_type": "Temporary water usage"
      },
      "type": "Feature"
    },
    {
      "geometry": {
        "coordinates": [
          [
            "22.749689941436348",
            "62.33005465890707",
            "77.54"
          ],
          [
            "22.749702365439873",
            "62.33006043693343",
            "0"
          ],
          [
            "22.749712062242082",
            "62.33040811612696",
            "79.9700001"
          ],
          [
            "22.749746719226334",
            "62.33064241947853",
            "80.1400001"
          ],
          [
            "22.749776543400365",
            "62.33094367738102",
            "81.14"
          ]
        ],
        "type": "LineString"
      },
      "properties": {
        "begin_node_id": 123337,
        "current_lifespan": 51,
        "diameter": 250,
        "end_node_id": 123336,
        "id": 123338,
        "material": "Cast iron",
        "pressure_class": "PN10",
        "technical_lifespan": null,
        "type": "Main duct"
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}
"1021"
Expand All
object

Modeling data

analysis
object

Analysis parameters. Can be one of the following schemas:

consumers
object

GeoJSON FeatureCollection containing all the consumer points

controltable
Array of object

Control tables for water tanks and pumping stations

object
pipenetwork
object

GeoJSON FeatureCollection containing all the duct and node objects

planid
integer

Modeling id from KeyAqua

401

Authentication credentials are missing or invalid

404

Task not found or results are not available yet


Was this article helpful?