Update Water Duct data partially

17 Jan 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Update Water Duct data partially

Updated on 17 Jan 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Patch

/water-duct/{id}/

Operation is used to update specific fields in existing Water Duct data.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of Water Duct to update

Body parameters

Water Duct attributes and values to be updated

object

Address

integer

Address Id

ConditionClass

integer

Condition Class Id

Plan

integer

Plan Id

Type

integer Required

Type Id

begin_z_coord

number (float)

Z-coordinate of the beginning point

begin_z_estimated

boolean

An indicator if the beginning point's z-coordinate is only an estimate

build_year

integer

Build year

condition_idx

integer

Condition index

connected_duct

number (float)

Connected duct ID

created_by

string

Created by

created_ts

string (date)

Date created

critical_index

integer

Critical index

duct_type

integer Required

Duct Type Id

end_z_coord

number (float)

Z-coordinate of the end point

end_z_estimated

boolean

An indicator if the end point's z-coordinate is only an estimate

epanet_mloss

number (float)

Minor losses

epanet_roughness

number (float)

Roughness coefficient

epanet_status

integer

Epanet Status Id

estimated_condition

integer

Estimated condition

feature

string

Feature

height_accuracy

integer

Height Accuracy Id

history_date

string (date)

History date

install_location

integer Required

Install Location Id

landxml_name

string

Landxml name

lbl_angle

string

Label angle

lbl_angle_exp

string

Export label angle

lbl_color

string

Label color

lbl_color_exp

string

Export label color

lbl_size

string

Label size

lbl_size_exp

string

Export label size

length

number (float)

3D length

length_2d

number (float)

2D length

location

string (ewkt)

Geographical location

location_accuracy

integer

Location Accuracy Id

mapper

string

Mapper

mapping_method

integer

Mapping Method Id

mslink

integer

Primary key

note

string

Additional details

owner

integer Required

Owner Id

plan_date

string (date)

Plan date

plan_number

integer

Plan number

removal_year

integer

Removal year

risk_index

integer

Risk index

state

integer Required

State Id

survey_number

integer

Survey number

sym_angle

string

Symbol angle

sym_angle_exp

string

Export symbol angle

sym_code_gt

string

Symbol code gt

sym_color

string

Symbol color

sym_color_exp

string

Export symbol color

sym_name

string

Symbol name

sym_name_exp

string

Export symbol name

sym_size

string

Symbol size

sym_size_exp

string

Export symbol size

sym_text

string

Symbol text

sym_text_exp

string

Export symbol text

sym_width

string

Symbol width

sym_width_exp

string

Export symbol width

updated_by

string

Updated by

updated_ts

string (date)

Date updated

user_id

string

User's ID

verbal_condition_info

string

Condition info

z_coord

string

Z-coordinate

Responses

200

Object was updated successfully

object

Address

integer

Address Id

ConditionClass

integer

Condition Class Id

Plan

integer

Plan Id

Type

integer

Type Id

begin_z_coord

number (float)

Z-coordinate of the beginning point

begin_z_estimated

boolean

An indicator if the beginning point's z-coordinate is only an estimate

build_year

integer

Build year

condition_idx

integer

Condition index

connected_duct

number (float)

Connected duct ID

created_by

string

Created by

created_ts

string (date)

Date created

critical_index

integer

Critical index

duct_type

integer

Duct Type Id

end_z_coord

number (float)

Z-coordinate of the end point

end_z_estimated

boolean

An indicator if the end point's z-coordinate is only an estimate

epanet_mloss

number (float)

Minor losses

epanet_roughness

number (float)

Roughness coefficient

epanet_status

integer

Epanet Status Id

estimated_condition

integer

Estimated condition

feature

string

Feature

height_accuracy

integer

Height Accuracy Id

history_date

string (date)

History date

install_location

integer

Install Location Id

landxml_name

string

Landxml name

lbl_angle

string

Label angle

lbl_angle_exp

string

Export label angle

lbl_color

string

Label color

lbl_color_exp

string

Export label color

lbl_size

string

Label size

lbl_size_exp

string

Export label size

length

number (float)

3D length

length_2d

number (float)

2D length

location

string (ewkt)

Geographical location

location_accuracy

integer

Location Accuracy Id

mapper

string

Mapper

mapping_method

integer

Mapping Method Id

mslink

integer

Primary key

note

string

Additional details

owner

integer

Owner Id

plan_date

string (date)

Plan date

plan_number

integer

Plan number

removal_year

integer

Removal year

risk_index

integer

Risk index

state

integer

State Id

survey_number

integer

Survey number

sym_angle

string

Symbol angle

sym_angle_exp

string

Export symbol angle

sym_code_gt

string

Symbol code gt

sym_color

string

Symbol color

sym_color_exp

string

Export symbol color

sym_name

string

Symbol name

sym_name_exp

string

Export symbol name

sym_size

string

Symbol size

sym_size_exp

string

Export symbol size

sym_text

string

Symbol text

sym_text_exp

string

Export symbol text

sym_width

string

Symbol width

sym_width_exp

string

Export symbol width

updated_by

string

Updated by

updated_ts

string (date)

Date updated

user_id

string

User's ID

verbal_condition_info

string

Condition info

z_coord

string

Z-coordinate

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Get list of Water Fireplug