Plots
Last updated
Last updated
Retrieve the specified plot.
A comma-separated list of relations to be included in the response. Possible relations are: mostRecentAnalysis.
mostRecentAnalysis
Lists all plots of your business.
Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1
Number of records per page. Example: 20 Default Value: 100 Max Value: 500
If provided value is greater than max value, max value will be applied.
Filter by commodities query param. Format: filter.commodities={$not}:OPERATION:VALUE Example: filter.commodities=$not:$like:John Doe&filter.commodities=like:John Available Operations$contains
Parameter to sort by. To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting Format: fieldName:DIRECTION Example: sortBy=id:DESC&sortBy=createdAt:ASC Default Value: createdAt:DESC Available FieldscreatedAt
List of fields to select. Example: Default Value: By default all fields returns. If you want to select only some fields, provide them in query param
A comma-separated list of relations to be included in the response. Possible relations are: mostRecentAnalysis, suppliers, mostRecentAnalysesByType. Deprecation: 'mostRecentAnalysis' is deprecated. Please use 'mostRecentAnalysesByType' as the response data will in particular include the data from 'mostRecentAnalysis'.
mostRecentAnalysesByType
Create a plot owned by your business.
What crops (among the relevant commodities) are grown on this field (currently).
["oil palm","rubber"]
Free text name of the plot. Useful for easily finding and identifying the plot as an enduser.
Short description to find and identify plots as owners.
The geometry of the plot with the polygon. Currently supported: Polygon geometry as defined in https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.
{"type":"Polygon","coordinates":[[[100,0],[101,0],[101,1],[100,1],[100,0]]]}
Deprecated. This will be automatically populated by the system. The country code (ISO 31661Alpha2 expected).
Is this plot active in the system
Filename of the file where the plot is defined
A customizable metadata field for storing additional information related to a plot in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.
The `customData` field is returned unchanged and is visible only to the owners of the plot.
Constraints:
- Up to 10 keys per object
- Key length: Maximum 255 characters
- String value length: Maximum 255 characters
- Values must be of type: string, number, or boolean
- Nested objects are not allowed
- Keys cannot contain: '__proto__', 'constructor', or 'prototype'
{"key1":"someValue","key2":true,"key3":1234}
Update the properties of the specified plot. Handles updates partially, i.e. properties missing in the request body will not be changed.
What crops (among the relevant commodities) are grown on this field (currently).
["oil palm","rubber"]
Free text name of the plot. Useful for easily finding and identifying the plot as an enduser.
Short description to find and identify plots as owners.
The geometry of the plot with the polygon. Currently supported: Polygon geometry as defined in https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.
{"type":"Polygon","coordinates":[[[100,0],[101,0],[101,1],[100,1],[100,0]]]}
Deprecated. This will be automatically populated by the system. The country code (ISO 31661Alpha2 expected).
Is this plot active in the system
Filename of the file where the plot is defined
A customizable metadata field for storing additional information related to a plot in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.
The `customData` field is returned unchanged and is visible only to the owners of the plot.
Constraints:
- Up to 10 keys per object
- Key length: Maximum 255 characters
- String value length: Maximum 255 characters
- Values must be of type: string, number, or boolean
- Nested objects are not allowed
- Keys cannot contain: '__proto__', 'constructor', or 'prototype'
{"key1":"someValue","key2":true,"key3":1234}