Get list of Points
- 29 Aug 2023
- 14 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Points
- Updated on 29 Aug 2023
- 14 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/keycore-points/
Operation is used to get a list of Points.
Points can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Query parameters
offset
integer
Offset to start returning results.
Min length0
limit
integer
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Min length1
__any of the object fields__
string
Filters list by selected object field value. Supports structured queries via ++++++ delimiter. Supports ending keywords via ++++++ delimiter:
- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
- For numerics: gt, lt, gte, lte, isnull
- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples:
+++usage_state__txt__istartswith=in+++,+++plan__state__txt__startswith=In+++,+++creation_date__gte=2019-01-02T15:32:01+++,+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
orderby
string
Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date
Responses
200
A result response object.
{
"angle": 90.00000000000001,
"color": "",
"created_by": "test user",
"created_ts": "2022-10-11T05:34:30.001334Z",
"description": "",
"distance": "0.0",
"haccuracy": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "H_ACCURACY",
"id": 117210,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/H_ACCURACY/",
"logical_txt": "Ei määritelty",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Ei määritelty"
},
"history_date": null,
"id": 10,
"identification": "",
"length": "0.0",
"location": "SRID=3067;POINT Z (458823.6567999999970198 6697544.1913999998942018 0.0000000000000000)",
"location_accuracy": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "LOCATION_ACCURACY",
"id": 8301,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
"logical_txt": "2.0m",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": 2.0,
"txt": "2.0m"
},
"mapper": "",
"mapping_method": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "MAPPING_METHOD",
"id": 390,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/MAPPING_METHOD/",
"logical_txt": "Digitoitu",
"num_value": 4.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Digitoitu"
},
"plan": null,
"point_type": {
"category": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "POINT_TYPE_CATEGORY",
"id": 242790,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/POINT_TYPE_CATEGORY/",
"logical_txt": "KeyRNS",
"num_value": -1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Telesymbolit"
},
"id": 1002,
"label": "Merkkiantenni",
"list_url": "http://10.121.8.101:8055/api/v2/point-types",
"name": "MERKKIANTENNI",
"symbol_name": "merkkiant"
},
"scale": null,
"size": null,
"state": null,
"survey_amount": ""
}object
Next
string
Url to next page of Points list. Null if No next page exist
Prev
string
Url to previous page of Points list. Null if No previous page exist
Results
Array of object (Point)
List of fetched Points
object
Point
Owner
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Renter
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
angle
number
Point rotation
color
string
Point color
created_by
string
Creator
created_ts
string
Creation date and time
description
string
Additional details
distance
number
Distance
haccuracy
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
history_date
string
Mapping date
id
integer
Unique id of point
identification
string
Identification of point
length
number
Length
location
string
Geographical location
location_accuracy
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
mapper
string
Mapper
mapping_method
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
plan
object
Plan
Branch_line
object
District Heating Consumer Point Duct Diameter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["DH_CP_DN"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Center_measure
object
District Heating Consumer Point Duct Diameter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["DH_CP_DN"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Construction
object
Plan Construction
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_CONSTRUCTION"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Excavation
object
Plan Excavation
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_EXCAVATION"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Limiter
object
District Heating Consumer Point Limiter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["DH_CP_LIMITER"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Plan_piping
object
Plan Piping
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_PIPING"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
agreed_delivery_date
string
Agreed Delivery Date. Activated on request by customer.
area_description
string
Area Description. Activated on request by customer.
begin_date
string
Begin Date
construction_year
integer
Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.
contact_email
string
Contact Email Address. Activated on request by customer.
contact_name
string
Contact Name. Activated on request by customer.
contact_phone
string
Contact phone number. Activated on request by customer.
cp_identification
string
Consumer Point Identification. Activated on request by customer.
created_by
string
Created by
created_date
string
Create Date
customer_contact_date
string
Customer Contact Date. Activated on request by customer.
description
string
Description
desired_delivery_date
string
Desired Delivery Date. Activated on request by customer.
district_area
object
District Area
location
string
Geographical location as EWKT representation
name
string
Name of District Area
duration
integer
Duration. Activated on request by customer.
expire_date
string
Expire Date
first_contact
string
First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.
id
integer
Unique id of plan
implementation_begin_end
string
Implementation Date. Activated on request by customer.
implementation_date
string
Implementation Date. Activated on request by customer.
latest_implementation_date
string
Latest Implementation Date. Activated on request by customer.
list_url
string
URL to the list of all Plans. Only shown when displaying plan details in related objects.
location
string
Geographical location. As EWKT representation
louhi_id
string
Louhi ID. Activated on request by customer.
modifications
string
Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.
name
string
Name of Plan
network
object
Plan Network Type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_NETWORK_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
network_owner
object
Plan Network Owner
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_NETWORK_OWNER"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
offer_accepted_date
string
Offer Accepted Date. Activated on request by customer.
offer_id
string
Offer ID. Activated on request by customer.
parentplan
string
URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.
plan_remark
string
Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.
plumbing_start_date
string
Plumbing Start Date. Activated on request by customer.
property_address
string
Property address. Not shown when displaying plan details in related objects. Activated on request by customer.
publicity
object
Plan Publicity
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_PUBLICITY"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
state
object
Plan state
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_STATE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
total_cost
number
Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.
type
object
Plan type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
updated_by
string
Updated by
updated_date
string
Update Date
work_activities
string
Work Activities. Activated on request by customer.
work_phase
object
Plan Work Phase
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_WORK_PHASE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_project
string
Work Project. Activated on request by customer.
work_type
object
Plan Work Type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_WORK_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_type_main
object
Plan Work Type Main
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_WORK_TYPE_MAIN"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_type_sub
object
Plan Work Type Sub
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["PLAN_WORK_TYPE_SUB"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
point_type
object
Point Type
category
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
id
integer
Unique id of point
label
string
Point type label
name
string
Point type name
symbol_name
string
Symbol name
safety_distance
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
scale
number
Point scale
size
integer
Point size
state
object
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
string
Group name of constant
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
survey_amount
string
Survey amount
updated_by
string
Last updater
updated_ts
string
Last updated date and time
Total
integer
Total number of Point in the list
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
