Update free area partially
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update free area partially
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/free-areas/{id}
Operation is used to update specific fields in existing free area. Available from product version 3.2.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of free area to update
Body parameters
Free area attributes and values to be updated
object
FreeArea
area_size
string
color
string
Free area color
created_by
string
Created by user
location
string (ewkt) Required
Geographical location as EWKT representation
name
string
Name of plan
perimeter
string
plan
integer
id of plan
state
integer
id of free area state
type
integer Required
id of type free area type. Only types that are linked to Categories are available for the types of FreeArea
Responses
200
Object was updated successfully
object
FreeArea
area_size
string
color
string
Free area color
created_by
string
Created by user
created_date
string (date-time)
Date of create
id
integer
Unique id of free area
location
string (ewkt)
Geographical location as EWKT representation
name
string
Name of plan
perimeter
string
plan
integer
id of plan
state
integer
id of free area state
type
integer
id of type free area type. Only types that are linked to Categories are available for the types of FreeArea
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?
