Get a list of plans

17 Jan 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Get a list of plans

Updated on 17 Jan 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/keycore-plans/

Get a list of plans

Plan can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned.

Minimum1

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

__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))+++

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.

[
  {
    "id": 515890,
    "location": "SRID=3067;POLYGON Z ((465232.2642696400289424 6704625.7400038000196218 0.0000000000000000, 464491.4313363498076797 6702191.5746515998616815 0.0000000000000000, 466885.9092100000125356 6702694.2827134998515248 0.0000000000000000, 467851.6378551700036041 6703831.9904324999079108 0.0000000000000000, 467811.9503766099223867 6704308.2401753002777696 0.0000000000000000, 465232.2642696400289424 6704625.7400038000196218 0.0000000000000000))",
    "name": "test123",
    "network": null,
    "state": {
      "groupname": "PLAN_STATE",
      "id": 231830,
      "list_url": "https://keyduct.example.com/api/v2/txt_constants/groupname/PLAN_STATE/",
      "logical_txt": "Esisuunnittelussa",
      "txt": "In preplanning"
    },
    "type": {
      "groupname": "PLAN_TYPE",
      "id": 231910,
      "list_url": "https://keyduct.example.com/api/v2/txt_constants/groupname/PLAN_TYPE/",
      "logical_txt": "Tietojen päivitys",
      "txt": "Information maintenance"
    }
  },
  {
    "id": 1238290,
    "location": "SRID=3067;POLYGON Z ((469433.3479662783211097 6706965.7640308598056436 0.0000000000000000, 469433.3479662800091319 6706936.1307135000824928 0.0000000000000000, 469502.6687621800228953 6706935.6015472002327442 0.0000000000000000, 469502.6687621800228953 6706966.2931973002851009 0.0000000000000000, 469443.9312939000083134 6706966.0286141000688076 0.0000000000000000, 469433.3479662783211097 6706965.7640308598056436 0.0000000000000000))",
    "name": "ABC",
    "network": null,
    "state": {
      "groupname": "PLAN_STATE",
      "id": 231850,
      "list_url": "https://keyduct.example.com/api/v2/txt_constants/groupname/PLAN_STATE/",
      "logical_txt": "Suunnittelussa",
      "txt": "Under planning"
    },
    "type": {
      "groupname": "PLAN_TYPE",
      "id": 232010,
      "list_url": "https://keyduct.example.com/api/v2/txt_constants/groupname/PLAN_TYPE/",
      "logical_txt": "Rakentaminen",
      "txt": "Construction"
    }
  }
]

Expand All

object

string (url)

Url to next page of plans. Null if No next page exist

string (url)

Url to previous page of plans. Null if No previous page exist

Results

Array of object (Plan)

object

Plan

Branch_line

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Center_measure

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Construction

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Excavation

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Limiter

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Plan_piping

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

agreed_delivery_date

string (date-time)

Agreed Delivery Date. Activated on request by customer.

area_description

string

Area Description. Activated on request by customer.

begin_date

string (date-time)

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 (date-time)

Create Date

customer_contact_date

string (date-time)

Customer Contact Date. Activated on request by customer.

description

string

Description

desired_delivery_date

string (date-time)

Desired Delivery Date. Activated on request by customer.

district_area

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

duration

integer

Duration. Activated on request by customer.

expire_date

string (date-time)

Expire Date

first_contact

string

First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.

integer

Unique id of plan

implementation_begin_end

string (date-time)

Implementation Date. Activated on request by customer.

implementation_date

string (date)

Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

latest_implementation_date

string (date)

Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

list_url

string (url)

URL to the list of all Plans. Only shown when displaying plan details in related objects.

location

string (ewkt)

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 (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

network_owner

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

offer_accepted_date

string (date-time)

Offer Accepted Date. Activated on request by customer.

offer_id

string

Offer ID. Activated on request by customer.

parentplan

string (url)

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 (date-time)

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 (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

state

object (PlanState)

Plan state

groupname

Group name of constant

Valid values[ "PLAN_STATE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

txt

string

Human readable textual representation

total_cost

number (float)

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 (PlanType)

Plan type

groupname

Group name of constant

Valid values[ "PLAN_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

txt

string

Human readable textual representation

updated_by

string

Updated by

updated_date

string (date-time)

Update Date

work_activities

string

Work Activities. Activated on request by customer.

work_phase

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

work_project

string

Work Project. Activated on request by customer.

work_type

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

work_type_main

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

work_type_sub

object (TxtConstant)

groupname

string

Group name of constant. Same as groupname parameter.

integer

Unique id of constant

logical_txt

string

Logical textual value

txt

string

Human readable textual representation (translated)

Total

integer

Total number of plans

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Create new plan