Create new plan

28 Oct 2024
4 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new plan

Updated on 28 Oct 2024
4 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/keycore-plans/

Operation is used to create new plan. Available from product version 3.0.22.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Plan to be created

object

Plan

Branch_line

integer

Branch Line ID. Activated on request by customer.

Center_measure

integer

Center Measure ID. Activated on request by customer.

Construction

integer

Construction ID. Activated on request by customer.

Excavation

integer

Exvacation ID. Activated on request by customer.

Limiter

integer

Limiter ID. Activated on request by customer.

Plan_piping

integer

Piping ID. Activated on request by customer.

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

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.

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

integer

District Area ID. Activated on request by customer.

duration

integer

Duration. Activated on request by customer.

expire_date

string (date-time)

Expire Date

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.

location

string (ewkt)

Geographical location. As EWKT representation

louhi_id

string

Louhi ID. Activated on request by customer.

name

string Required

Name

network

integer

Network Type ID

network_owner

integer

Plan Network Owner ID. Activated on request by customer.

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

integer

Plan ID of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.

plumbing_start_date

string (date-time)

Plumbing Start Date. Activated on request by customer.

publicity

integer

Plan Publicity ID. Activated on request by customer.

state

integer Required

Plan State ID

type

integer Required

Plan Type ID

work_activities

string

Work Activities. Activated on request by customer.

work_phase

integer

Work Phase ID. Activated on request by customer.

work_project

string

Work Project. Activated on request by customer.

work_type

integer

Work Type ID. Activated on request by customer.

work_type_main

integer

Work Type Main ID. Activated on request by customer.

work_type_sub

integer

Work Type Sub ID. Activated on request by customer.

Responses

204

A created plan

object

Plan

Branch_line

integer

Branch Line ID. Activated on request by customer.

Center_measure

integer

Center Measure ID. Activated on request by customer.

Construction

integer

Construction ID. Activated on request by customer.

Excavation

integer

Exvacation ID. Activated on request by customer.

Limiter

integer

Limiter ID. Activated on request by customer.

Plan_piping

integer

Piping ID. Activated on request by customer.

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

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

integer

District Area ID. Activated on request by customer.

duration

integer

Duration. Activated on request by customer.

expire_date

string (date-time)

Expire Date

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.

location

string (ewkt)

Geographical location. As EWKT representation

louhi_id

string

Louhi ID. Activated on request by customer.

name

string

Name

network

integer

Network Type ID

network_owner

integer

Plan Network Owner ID. Activated on request by customer.

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

integer

Plan ID of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.

plumbing_start_date

string (date-time)

Plumbing Start Date. Activated on request by customer.

publicity

integer

Plan Publicity ID. Activated on request by customer.

state

integer

Plan State ID

type

integer

Plan Type ID

updated_by

string

Updated by

updated_date

string (date-time)

Update Date

work_activities

string

Work Activities. Activated on request by customer.

work_phase

integer

Work Phase ID. Activated on request by customer.

work_project

string

Work Project. Activated on request by customer.

work_type

integer

Work Type ID. Activated on request by customer.

work_type_main

integer

Work Type Main ID. Activated on request by customer.

work_type_sub

integer

Work Type Sub ID. Activated on request by customer.

400

There was an error in request. Usually field validation failed.

{
  "plan_type": [
    "This field is required."
  ],
  "state": [
    "This field is required."
  ]
}

object

Fields which failed validation

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

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

Delete plan