- KeyCom
- KeyCom REST API (introduction)
- KeyCom REST API
- Address
- Address alias
- Apartment
- Attached Document
- Cable
- Circuit
- Circuit Connection
- Circuit faults
- Circuit Location
- Circuit Physical Reservation
- Circuit Reservation Data
- Circuit Section
- Circuit Services
- Cancel work order post
- Circuit fault location get
- Create circuit fault location post
- Complete work order post
- Create new circuit post
- Create new circuit with port post
- Delete work order post
- Get circuit port post
- Get route information post
- Create Work Order post
- Get route information - abnormal connections post
- Get route information - logical reservations post
- Get route information - physical reservations post
- Get route information - provisioning devices post
- Get route information - connections to be deleted post
- Release Port post
- Release work order post
- Reserve Port post
- Search circuit post
- Terminate work order post
- Update installation date post
- Update work order post
- Cancel work order
- Collections
- Get a list of External Document types get
- Get cable type details get
- Get list of Cable types get
- Get list of constants get
- Get list of Convert Codes get
- Get list of cross connection point types get
- Get list of Mapping Configs get
- Get list of object types get
- Get list of Point Types get
- Get list of Survey Constants by groupname get
- Get list of telecom duct types get
- Get list of telecom premises types get
- Get a list of External Document types
- Contract
- Contract Link
- Create connections
- Cross connection point
- Customer
- Device
- Device Group
- Duct Group
- Duct Group Row
- Exchange Area
- External Document
- Extra Attribute
- Extra Value
- FreeArea
- FreeLine
- Logical connections
- Manhole
- Passed Services
- Plan
- Point
- Pole
- Routefollower
- Service Area
- Source system address
- Source system apartment
- Splice
- Supercable
- Telecom Area
- Telecom Cable Connection
- Telecom Conduit
- Telecom Conduit Connection
- Telecom Conduit Link
- Telecom Duct
- Telecom Duct Connection
- Telecom Duct Link
- Telecom premises
- Terminal type
- TxtConstant
- Survey Constant
- Survey Files
- Survey File
- Survey Line Strings
- Survey Line String
- Survey Point
- KeyAqua/KeyHeat
- KeyAqua/KeyHeat REST API (introduction)
- KeyAqua/KeyHeat REST API
- Address
- Apartment
- KeyUv Component
- Consumer Point Connection
- Consumer Point Property
- Consumer Point Real Estate
- Consumer Point User Email
- Consumer Point User
- Consumer Point
- Consumer Point Linked Address
- Contact Person Connection
- Contact Person
- Customer
- Dh Cable
- Dh Conduit
- Dh Division
- Dh Duct
- Dh Manhole
- Dh Manhole Link Connection
- Dh Meter Reading
- Dh Valve
- Error Report
- External Document
- Extra Attribute
- Extra Value
- Failure Report
- KeyUv Fault Component
- KeyUv Fault
- Fire Water Station
- Flow Meter Reading
- Flow Meter
- FreeArea
- Gas Cable
- Gas Meter Reading
- Gas Other Node
- Gas Valve
- Gas Meter
- Junction Connection
- Junction
- Duct Condition Detail
- Plan
- Point
- Keydh Connection
- Keydh Node
- KeyDh Observation
- Keygas Duct
- Gas Manhole
- Sn Modeling
- Modeling Data
- Sn Modeling Run
- Collections
- Real Estate
- KeyUv SAttribute
- Sewer Duct Renovation
- Sewer Branch
- Sewer Duct
- Sewer Manhole
- Sewer Measuring Points
- Sewer Measuring Point
- Sewer Sewer Measuring Point
- Sewer Other Nodes
- Sewer Other Node
- Sewer Pumping Station
- Sewer Valve
- Sn Constant
- KeyUv SubRegion
- KeyUv Task
- Text Constant
- Water Branch
- Water Duct
- Water Fireplug
- Water Hydrant
- Water Measuring Point
- Water Node
- Water Other Node
- Water Pumping Station
- Water Duct Renovation
- Water Tank
- Water Valve
- KeyLight
- KeyLight REST API (introduction)
- KeyLight REST API
- Address alias
- Address
- Apartment
- Attached Document
- Collections
- Get list of bitrates get
- Get a list of External Document types get
- Get list of electrical cable types get
- Get list of electric divisions get
- Get list of electrical duct types get
- Get details of light models for specific manufacturer get
- Get list of light light models for specific manufacturer get
- Get list of electrical premises types get
- Get list of object types get
- Get list of Point Types get
- Get list of constants get
- Get list of bitrates
- Electric Cable Connection
- Electric Cable
- Electric Conduit Connection
- Electric Conduit Link
- Electric Conduit
- Electric Duct Link
- Electric Duct
- Electric Fuse
- Electric Manhole
- Electric Point Object
- Electric Pole
- Electric Premises
- Electric Routefollower
- Electric Splice
- Streetlight
- Source system address
- Source system apartment
- External Document
- Extra Attribute
- Extra Value
- FreeArea
- Plan
- Point
- TxtConstant
- Print
- DarkLight
- PDF
Operation is used to get a list of Points.
Points can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Token issued for API consumer.
Offset to start returning results.
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.
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+++
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
A result response object.
{
"angle": 90.00000000000001,
"color": "",
"created_by": "test user",
"created_ts": "2022-10-11T05:34:30Z",
"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": "",
"installYear": 2023,
"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": ""
}
Url to next page of Points list. Null if No next page exist
Url to previous page of Points list. Null if No previous page exist
List of fetched Points
Point
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Point rotation
Point color
Creator
Creation date and time
Additional details
Distance
Height accuracy
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Mapping date
Unique id of point
Identification of point
Install year. Available from product version 3.6.8.
Length
Geographical location
Location accuracy
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Mapper
Mapping method
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan
District Heating Consumer Point Duct Diameter
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
District Heating Consumer Point Duct Diameter
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Construction
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Excavation
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
District Heating Consumer Point Limiter
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Piping
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Agreed Delivery Date. Activated on request by customer.
Area Description. Activated on request by customer.
Begin Date
Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.
Contact Email Address. Activated on request by customer.
Contact Name. Activated on request by customer.
Contact phone number. Activated on request by customer.
Consumer Point Identification. Activated on request by customer.
Created by
Create Date
Customer Contact Date. Activated on request by customer.
Description
Desired Delivery Date. Activated on request by customer.
District Area
Geographical location as EWKT representation
Name of District Area
Duration. Activated on request by customer.
Expire Date
First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.
Unique id of plan
Implementation Date. Activated on request by customer.
Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
URL to the list of all Plans. Only shown when displaying plan details in related objects.
Geographical location. As EWKT representation
Louhi ID. Activated on request by customer.
Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.
Name of Plan
Plan Network Type
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Network Owner
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Offer Accepted Date. Activated on request by customer.
Offer ID. Activated on request by customer.
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. Not shown when displaying plan details in related objects. Activated on request by customer.
Plumbing Start Date. Activated on request by customer.
Property address. Not shown when displaying plan details in related objects. Activated on request by customer.
Plan Publicity
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan state
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.
Plan type
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Updated by
Update Date
Work Activities. Activated on request by customer.
Plan Work Phase
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Work Project. Activated on request by customer.
Plan Work Type
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Work Type Main
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Plan Work Type Sub
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Point Type
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Unique id of point
Point type label
Point type name
Symbol name
Safety Distance
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant.
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Point scale
Point size
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all contants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Survey amount
Last updater
Last updated date and time
Total number of Point in the list
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}
Detailed description of error
curl --request GET \
--url https://yourserverurl.com/keycore-points/ \
--header 'Authorization: REPLACE_KEY_VALUE' \
--header 'accept: application/json'
xxxxxxxxxx
curl --request GET \
--url https://yourserverurl.com/keycore-points/ \
--header 'Authorization: REPLACE_KEY_VALUE' \
--header 'accept: application/json'