Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The /data resource represents the data querying capabilities of Weave.


Metadata

All /data resources support a 'metadata' boolean query parameter. This parameter determines if a column definition of the queried data is returned along with the result.

1. Top-level resource: services/v1/data

Provides a list of all data definitions configured and accessible to the user on Weave.

Example 1 - When metadata=true

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data?metadata=true'

Output

[
  {
    "columns": [
      {
        "id": "_id",
        "key": true,
        "label": "Id",
        "type": "int"
      },
      {
        "id": "ogc_fid",
        "label": "Ogc Fid",
        "type": "int"
      },
      {
        "id": "postcode",
        "label": "Postcode",
        "type": "float"
      }
    ],
    "entity": "postcode",
    "id": "postcodeDetails",
    "label": "Postcode"
  },
  {
    "columns": [
      {
        "id": "_id",
        "key": true,
        "label": "Id",
        "type": "string"
      },
      {
        "id": "plannumber",
        "label": "Plannumber",
        "type": "string"
      },
      {
        "id": "sectionnum",
        "label": "Sectionnum",
        "type": "string"
      },
      {
        "id": "lotnumber",
        "label": "Lotnumber",
        "type": "string"
      },
      {
        "id": "propid",
        "label": "Propid",
        "type": "string"
      },
      {
        "id": "hasproperty",
        "label": "Hasproperty",
        "type": "string"
      },
      {
        "id": "address",
        "label": "Address",
        "type": "string"
      },
      {
        "id": "postcode_segment",
        "label": "Postcode Segment",
        "type": "string"
      },
      {
        "id": "suburb_segment",
        "label": "Suburb Segment",
        "type": "string"
      },
      {
        "id": "poi_segment",
        "label": "Poi Segment",
        "type": "string"
      },
      {
        "id": "address_segment",
        "label": "Address Segment",
        "type": "string"
      },
      {
        "id": "processdate",
        "label": "Processdate",
        "type": "string"
      },
      {
        "id": "ogc_fid",
        "label": "Ogc Fid",
        "type": "int"
      }
    ],
    "entity": "property",
    "id": "addresspoiDetails",
    "label": "Property"
  },
  {
    "columns": [
      {
        "id": "_id",
        "key": true,
        "label": "Id",
        "type": "int"
      },
      {
        "id": "ogc_fid",
        "label": "Ogc Fid",
        "type": "int"
      },
      {
        "id": "foreshore_code",
        "label": "Foreshore Code",
        "type": "string"
      },
      {
        "id": "description",
        "label": "Description",
        "type": "string"
      },
      {
        "id": "legislation_schedule_num",
        "label": "Legislation Schedule Num",
        "type": "string"
      },
      {
        "id": "schedule_part_num",
        "label": "Schedule Part Num",
        "type": "string"
      },
      {
        "id": "part_item_num",
        "label": "Part Item Num",
        "type": "string"
      },
      {
        "id": "additional_reference_desc",
        "label": "Additional Reference Desc",
        "type": "string"
      },
      {
        "id": "epi_name",
        "label": "Epi Name",
        "type": "string"
      },
      {
        "id": "epi_type",
        "label": "Epi Type",
        "type": "string"
      },
      {
        "id": "lga_code",
        "label": "Lga Code",
        "type": "int"
      },
      {
        "id": "lga_name",
        "label": "Lga Name",
        "type": "string"
      },
      {
        "id": "published_date",
        "label": "Published Date",
        "type": "date"
      },
      {
        "id": "commenced_date",
        "label": "Commenced Date",
        "type": "date"
      },
      {
        "id": "currency_date",
        "label": "Currency Date",
        "type": "date"
      },
      {
        "id": "amendment",
        "label": "Amendment",
        "type": "string"
      },
      {
        "id": "growth_area",
        "label": "Growth Area",
        "type": "string"
      },
      {
        "id": "precinct",
        "label": "Precinct",
        "type": "string"
      },
      {
        "id": "survey_area",
        "label": "Survey Area",
        "type": "float"
      },
      {
        "id": "ext_dept_reference",
        "label": "Ext Dept Reference",
        "type": "string"
      },
      {
        "id": "ext_dept_system",
        "label": "Ext Dept System",
        "type": "string"
      },
      {
        "id": "ext_dept_link",
        "label": "Ext Dept Link",
        "type": "string"
      },
      {
        "id": "planning_hierarchy",
        "label": "Planning Hierarchy",
        "type": "string"
      },
      {
        "id": "pco_ref_key",
        "label": "Pco Ref Key",
        "type": "string"
      },
      {
        "id": "pco_letter_link",
        "label": "Pco Letter Link",
        "type": "string"
      },
      {
        "id": "pco_epi_link",
        "label": "Pco Epi Link",
        "type": "string"
      },
      {
        "id": "pco_map_layer_link",
        "label": "Pco Map Layer Link",
        "type": "string"
      },
      {
        "id": "pco_details_link",
        "label": "Pco Details Link",
        "type": "string"
      },
      {
        "id": "attachment_ref_id",
        "label": "Attachment Ref Id",
        "type": "string"
      },
      {
        "id": "exception_area",
        "label": "Exception Area",
        "type": "string"
      },
      {
        "id": "exception_clause",
        "label": "Exception Clause",
        "type": "string"
      },
      {
        "id": "exception_value",
        "label": "Exception Value",
        "type": "string"
      },
      {
        "id": "exception_area_2",
        "label": "Exception Area 2",
        "type": "string"
      },
      {
        "id": "exception_clause_2",
        "label": "Exception Clause 2",
        "type": "string"
      },
      {
        "id": "exception_value_2",
        "label": "Exception Value 2",
        "type": "string"
      },
      {
        "id": "created_user",
        "label": "Created User",
        "type": "string"
      },
      {
        "id": "created_date",
        "label": "Created Date",
        "type": "date"
      },
      {
        "id": "last_edited_user",
        "label": "Last Edited User",
        "type": "string"
      },
      {
        "id": "last_edited_date",
        "label": "Last Edited Date",
        "type": "date"
      },
      {
        "id": "objectid",
        "label": "Objectid",
        "type": "int"
      }
    ],
    "entity": "front_building_line",
    "id": "front_building_lineDetails",
    "label": "Front Building Line"
  },
  {
    "columns": [
      {
        "id": "_id",
        "key": true,
        "label": "Id",
        "type": "int"
      },
      {
        "id": "name",
        "label": "Name",
        "type": "string"
      },
      {
        "id": "type",
        "label": "Type",
        "type": "string"
      },
      {
        "id": "lganame",
        "label": "Lganame",
        "type": "string"
      },
      {
        "id": "status",
        "label": "Status",
        "type": "string"
      },
      {
        "id": "lgacode",
        "label": "Lgacode",
        "type": "string"
      },
      {
        "id": "ogc_fid",
        "label": "Ogc Fid",
        "type": "int"
      }
    ],
    "entity": "areasearch",
    "id": "areasearchDetails",
    "label": "Areasearch"
  }
]


Example 2 - When metadata=false

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data?metadata=false'


Output

[
  {
    "entity": "postcode",
    "id": "postcodeDetails",
    "label": "Postcode"
  },
  {
    "entity": "property",
    "id": "addresspoiDetails",
    "label": "Property"
  },
  {
    "entity": "front_building_line",
    "id": "front_building_lineDetails",
    "label": "Front Building Line"
  },
  {
    "entity": "areasearch",
    "id": "areasearchDetails",
    "label": "Areasearch"
  }
]


Sub-resources:

1. /data/execute/ids/{dataId}

For the given feature id, queries and returns data matching the provided data configuration id.

Parameters

GET query parameters:

ids - list of strings - feature ids (identifies individual entity items)


Example 2

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data/execute/ids/addresspoiDetails?ids=710247_2&metadata=false'


Output

{
  "total": 1,
  "results": [
    [
      "710247_2",
      "DP710247",
      null,
      "2",
      "710247_2",
      "0",
      "",
      "",
      "",
      null,
      "",
      "20151027",
      12
    ]
  ]
}



2. /data/execute/line/{dataId}

Returns data associated with the geometrical line segment along the two specified vertices. E.g. when working with  property layer this refers to properties that fall within the specified spatial operation along the specified geometrical line.

Example 3

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data/execute/line/addresspoiDetails?entity=property&x1=16784645.367663&y1=-4107061.3011045&x2=16784700.367663&y2=-4106561.3011045&crs=EPSG%3A3857&spatialOperation=intersects&selectedOnly=false&metadata=false'


Output

{
  "total": 16,
  "results": [
    [
      "76365_2-4_Marsh_Place___Albion_Park",
      "SP76365",
      null,
      null,
      "76365_2-4_Marsh_Place___Albion_Park",
      "0",
      "2-4 Marsh Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "2-4 Marsh Place ",
      "20151027",
      177951
    ],
    [
      "1043766_5_Mcgill_Close__36_Albion_Park_DP262341",
      "DP262341",
      null,
      "36",
      "1043766_5_Mcgill_Close__36_Albion_Park_DP262341",
      "1",
      "5 Mcgill Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "5 Mcgill Close ",
      "20151027",
      175780
    ],
    [
      "1048997_13_Smith_Avenue__107_Albion_Park_DP793040",
      "DP793040",
      null,
      "107",
      "1048997_13_Smith_Avenue__107_Albion_Park_DP793040",
      "1",
      "13 Smith Avenue, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "13 Smith Avenue ",
      "20151027",
      178810
    ],
    [
      "76365_Unit_1_2-4_Marsh_Place___Albion_Park",
      "SP76365",
      null,
      null,
      "76365_Unit_1_2-4_Marsh_Place___Albion_Park",
      "0",
      "1 2-4 Marsh Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "Unit 1 2-4 Marsh Place ",
      "20151027",
      176361
    ],
    [
      "1043635_6_Mccoy_Place__106_Albion_Park_DP713781",
      "DP713781",
      null,
      "106",
      "1043635_6_Mccoy_Place__106_Albion_Park_DP713781",
      "1",
      "6 Mccoy Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "6 Mccoy Place ",
      "20151027",
      174975
    ],
    [
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "DP793040",
      null,
      "155",
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "1",
      "10 Smith Avenue, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "10 Smith Avenue ",
      "20151027",
      178693
    ],
    [
      "1031305_1_Aitken_Close__44_Albion_Park_DP263741",
      "DP263741",
      null,
      "44",
      "1031305_1_Aitken_Close__44_Albion_Park_DP263741",
      "1",
      "1 Aitken Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "1 Aitken Close ",
      "20151027",
      176992
    ],
    [
      "76365_Unit_2_2-4_Marsh_Place___Albion_Park",
      "SP76365",
      null,
      null,
      "76365_Unit_2_2-4_Marsh_Place___Albion_Park",
      "0",
      "2 2-4 Marsh Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "Unit 2 2-4 Marsh Place ",
      "20151027",
      176243
    ],
    [
      "1043399_3_Marsh_Place__14_Albion_Park_DP262341",
      "DP262341",
      null,
      "14",
      "1043399_3_Marsh_Place__14_Albion_Park_DP262341",
      "1",
      "3 Marsh Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "3 Marsh Place ",
      "20151027",
      178698
    ],
    [
      "1031306_3_Aitken_Close__45_Albion_Park_DP263741",
      "DP263741",
      null,
      "45",
      "1031306_3_Aitken_Close__45_Albion_Park_DP263741",
      "1",
      "3 Aitken Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "3 Aitken Close ",
      "20151027",
      175804
    ],
    [
      "1031859_17_Badgery_Street__43_Albion_Park_DP263741",
      "DP263741",
      null,
      "43",
      "1031859_17_Badgery_Street__43_Albion_Park_DP263741",
      "1",
      "17 Badgery Street, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "17 Badgery Street ",
      "20151027",
      176507
    ],
    [
      "1043400_1_Marsh_Place__15_Albion_Park_DP262341",
      "DP262341",
      null,
      "15",
      "1043400_1_Marsh_Place__15_Albion_Park_DP262341",
      "1",
      "1 Marsh Place, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "1 Marsh Place ",
      "20151027",
      177996
    ],
    [
      "1043768_1_Mcgill_Close__38_Albion_Park_DP262341",
      "DP262341",
      null,
      "38",
      "1043768_1_Mcgill_Close__38_Albion_Park_DP262341",
      "1",
      "1 Mcgill Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "1 Mcgill Close ",
      "20151027",
      175234
    ],
    [
      "1040070_15_Hughes_Drive__16_Albion_Park_DP262341",
      "DP262341",
      null,
      "16",
      "1040070_15_Hughes_Drive__16_Albion_Park_DP262341",
      "1",
      "15 Hughes Drive, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "15 Hughes Drive ",
      "20151027",
      174120
    ],
    [
      "1043767_3_Mcgill_Close__37_Albion_Park_DP262341",
      "DP262341",
      null,
      "37",
      "1043767_3_Mcgill_Close__37_Albion_Park_DP262341",
      "1",
      "3 Mcgill Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "3 Mcgill Close ",
      "20151027",
      177972
    ],
    [
      "1043765_7_Mcgill_Close__35_Albion_Park_DP262341",
      "DP262341",
      null,
      "35",
      "1043765_7_Mcgill_Close__35_Albion_Park_DP262341",
      "1",
      "7 Mcgill Close, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "7 Mcgill Close ",
      "20151027",
      175043
    ]
  ]
}


3. /data/execute/search/{dataId}

Returns data associated with the specified search string.

Example 4

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data/execute/search/addresspoiDetails?searchId=addresspoi&parameters=plannumber%3DDP778240&metadata=false'


Output

{
  "total": 2,
  "results": [
    [
      "2744144_89_Fiona_Crescent__10_Lake_Cathie_DP778239",
      "89 Fiona Crescent, Lake Cathie, 2445",
      "13 Smith Avenue ",
      "1",
      "10",
      178810,
      "DP778239",
      null,
      "2445",
      "20151027",
      null,
      "2744144_89_Fiona_Crescent__10_Lake_Cathie_DP778239",
      null,
      "Lake Cathie"
    ],
	[
      "2744145_87_Fiona_Crescent__9_Lake_Cathie_DP778239",
      "87 Fiona Crescent, Lake Cathie, 2445",
      "13 Smith Avenue ",
      "1",
      "9",
      178810,
      "DP778239",
      null,
      "2445",
      "20151027",
      null,
      "2744145_87_Fiona_Crescent__9_Lake_Cathie_DP778239",
      null,
      "Lake Cathie"
    ]
  ]
}


4. /data/execute/linearray/{dataId}

Returns data associated with the provided shape. E.g. in the property layer, this means the properties intersecting the specified line array geometrical shape.

Example 5

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data/execute/linearray/addresspoiDetails?entity=property&crs=EPSG%3A3857&spatialOperation=intersects&selectedOnly=false&metadata=false&points=16784645.367%2C-4107061.301%2C16784642.367%2C-4107061.301%2C16784645.367%2C-4107066.301'


Output

 {
  "total": 1,
  "results": [
    [
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "10 Smith Avenue, Albion Park, 2527",
      "10 Smith Avenue ",
      "1",
      "155",
      178693,
      "DP793040",
      null,
      "2527",
      "20151027",
      null,
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      null,
      "Albion Park"
    ]
  ]
}


5. /data/execute/buffer/{dataId}

Returns data associated with the specified spatial operation on the map area of the point and the buffer area specified around it. E.g. in the property layer, when an 'intersect ' operation is specified this refers to properties that intersect the specified point and the geometrical buffer around the point.

Example 6

curl -X GET --header 'Accept: application/json' 'http://52.62.90.95:9090/weave/services/v1/data/execute/buffer/addresspoiDetails?entity=property&x=16784645.367663&y=-4107061.3011045&radius=10&crs=EPSG%3A3857&spatialOperation=intersects&selectedOnly=false&metadata=false'


Output

{
  "total": 2,
  "results": [
    [
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "10 Smith Avenue, Albion Park, 2527",
      "10 Smith Avenue ",
      "1",
      "155",
      178693,
      "DP793040",
      null,
      "2527",
      "20151027",
      null,
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      null,
      "Albion Park"
    ],
    [
      "1049015_8_Smith_Avenue__154_Albion_Park_DP793040",
      "8 Smith Avenue, Albion Park, 2527",
      "8 Smith Avenue ",
      "1",
      "154",
      178340,
      "DP793040",
      null,
      "2527",
      "20151027",
      null,
      "1049015_8_Smith_Avenue__154_Albion_Park_DP793040",
      null,
      "Albion Park"
    ]
  ]
}


6. /data/execute/point/{dataId}

Returns data associated with the the specified shape. E.g. in the property layer, this means the property that encompasses the geometrical point on the map.

Example 7 

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/data/execute/point/addresspoiDetails?entity=property&x=16784645.367663&y=-4107061.3011045&crs=EPSG%3A3857&spatialOperation=intersects&selectedOnly=false&metadata=false'


Output

{
  "total": 1,
  "results": [
    [
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "10 Smith Avenue, Albion Park, 2527",
      "10 Smith Avenue ",
      "1",
      "155",
      178693,
      "DP793040",
      null,
      "2527",
      "20151027",
      null,
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      null,
      "Albion Park"
    ]
  ]
}


7. /data/execute/geometry/{dataId}

Returns data associated with the specified envelope on the map.

Example 8

curl -X GET --header 'Accept: application/json' 'http://localhost:8087/weave/services/v1/data/execute/geometry/addresspoiDetails?entity=property&minx=16784645.367663&miny=-4107061.3011045&maxx=16784700.367663&maxy=4106561.3011045&crs=EPSG%3A3857&spatialOperation=within&selectedOnly=false&metadata=false'


Output

{
  "total": 2,
  "results": [
    [
      "2588700_3_Witley_Close__8_St_Marys_DP259595",
      "DP259595",
      null,
      "8",
      "2588700_3_Witley_Close__8_St_Marys_DP259595",
      "1",
      "3 Witley Close, St Marys, 2760",
      "2760",
      "St Marys",
      null,
      "3 Witley Close ",
      "20151027",
      485103
    ],
    [
      "2588533_25_Windrush_Circuit__4626_St_Clair_DP263114",
      "DP263114",
      null,
      "4626",
      "2588533_25_Windrush_Circuit__4626_St_Clair_DP263114",
      "1",
      "25 Windrush Circuit, St Clair, 2759",
      "2759",
      "St Clair",
      null,
      "25 Windrush Circuit ",
      "20151027",
      642052
    ] ]
}


8. /data/execute/selection/{dataId}

Returns data associated with the selections of an entity.

Example 9

curl -X GET --header 'Accept: application/json' 'http://localhost:8087/weave/services/v1/data/execute/selection/addresspoiDetails?entity=property&metadata=false'


Output

{
  "total": 1,
  "results": [
    [
      "1933692_3_Paul_Street__A_Balmain_East_DP450005",
      "DP450005",
      null,
      "A",
      "1933692_3_Paul_Street__A_Balmain_East_DP450005",
      "1",
      "3 Paul Street, Balmain East, 2041",
      "2041",
      "Balmain East",
      null,
      "3 Paul Street ",
      "20151027",
      4333228
    ]
  ]
}


9. /data/execute/polygonarray/{dataId}

Returns data associated with the specified spatial operation on the provided polygonarray shape on the map.

Example 10

curl -X GET --header 'Accept: application/json' 'http://localhost:8087/weave/services/v1/data/execute/polygonarray/addresspoiDetails?entity=property&crs=EPSG%3A3857&spatialOperation=intersects&selectedOnly=false&metadata=false&points=16784645.367%2C-4107061.301%2C16784642.367%2C-4107061.301%2C16784645.367%2C-4107066.301'


Output

{
  "total": 1,
  "results": [
    [
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "DP793040",
      null,
      "155",
      "1049014_10_Smith_Avenue__155_Albion_Park_DP793040",
      "1",
      "10 Smith Avenue, Albion Park, 2527",
      "2527",
      "Albion Park",
      null,
      "10 Smith Avenue ",
      "20151027",
      178693
    ]
  ]
}
  • No labels