Update pole partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update pole partially

  • Dark
    Light
  • PDF

Article summary

Patch
/poles/{id}/

Operation is used to update specific fields in existing pole. Available from product version 3.2.24.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of pole to update

Body parameters

Pole attributes and values to be updated

object
angle
number (float)

Angle

branch_pole_number
string

Branch Pole

checkout_date
string (date)

Checkout Date

decay_class
integer

Id of decay class

height_accuracy
integer

Id of height accuracy

history_date
string (date)

Checkout Date

impregnant
integer

Id of impregnant

install_year
integer

Install year

length
number (float)

Pole length

line_part
string

Line Part

location
string (ewkt)

Location of pole in EWKT

location_accuracy
integer

Id of location accuracy

mapper
string

Mapper

mapping_method
integer

Id of mapping method

material
integer

Id of material

owner
integer

Id of owner

plan
integer

Id of plan

pole_number
string

Pole number

pole_type
integer Required

Id of pole type

remarks
string

Remarks. Available from product version 3.2.14.

renter
integer

Id of renter

scale
number (float)

Scale

stanchion
integer

Id of stanchion

stanchion_decay_class
integer

Id of stanchion decay class

survey_amount
string

Survey amount

telecom_area
integer

Id of telecom area

usage_state
integer Required

Id of state

Responses
200

Object was updated successfully

object
angle
number (float)

Angle

branch_pole_number
string

Branch Pole

checkout_date
string (date)

Checkout Date

created_by
string

Created by

created_ts
string (date-time)

Created timestamp

decay_class
integer

Id of decay class

height_accuracy
integer

Id of height accuracy

history_date
string (date)

Checkout Date

id
integer

Primary key

impregnant
integer

Id of impregnant

install_year
integer

Install year

length
number (float)

Pole length

line_part
string

Line Part

location
string (ewkt)

Location of pole in EWKT

location_accuracy
integer

Id of location accuracy

mapper
string

Mapper

mapping_method
integer

Id of mapping method

material
integer

Id of material

owner
integer

Id of owner

plan
integer

Id of plan

pole_number
string

Pole number

pole_type
integer

Id of pole type

remarks
string

Remarks. Available from product version 3.2.14.

renter
integer

Id of renter

scale
number (float)

Scale

stanchion
integer

Id of stanchion

stanchion_decay_class
integer

Id of stanchion decay class

survey_amount
string

Survey amount

telecom_area
integer

Id of telecom area

updated_by
string

Last updated by

updated_ts
string (date-time)

Last updated timestamp

usage_state
integer

Id of state

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?