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

Update free line partially

  • Dark
    Light
  • PDF

Article summary

Patch
/free-lines/{id}/

Operation is used to update specific fields in existing free line. Available from product version 3.7.0.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of free line to update

Body parameters

Free line attributes and values to be updated

object

FreeLine

color
string

Free line color

description
string
length
number (float)
line_width
integer Required

Free line line width

location
string (ewkt)

Geographical location as EWKT representation

plan
integer

id of plan

state
integer

id of free line state

type
integer

id of type free line type.

Responses
200

Object was updated successfully

object

FreeLine

color
string

Free line color

created_by
string

Created by user

created_date
string (date-time)

Date of create

description
string
id
integer

Unique id of free line

length
number (float)
line_width
integer

Free line line width

location
string (ewkt)

Geographical location as EWKT representation

plan
integer

id of plan

state
integer

id of free line state

type
integer

id of type free line type.

updated_by
string

Updated by user

updated_date
string (date-time)

Date of update

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?