Create new free line
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new free line

  • Dark
    Light
  • PDF

Article summary

Post
/free-lines/

Operation is used to create free line. Available from product version 3.7.0.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Free line to be created

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
204

A created free line

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

400

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

{
  "line_width": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this field name

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?