# Plots ## List all plots. > Lists all plots of your business. ```json {"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.44.2"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetPlotBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n This field is deprecated and will be removed in the future. Please use\n customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","sentByUser","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view surveys"},"canViewOwnedSurveyResponses":{"type":"boolean","default":true,"description":"Indicates whether the user can view the survey responses owned by their business"},"canViewSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the survey responses of their tier-1 suppliers"},"canMutateOwnedSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can update or delete survey responses or create a new survey response owned by their business"},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own survey responses or the completed survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewSurveys","canViewOwnedSurveyResponses","canViewSurveyResponsesOfTier1Suppliers","canMutateOwnedSurveyResponses","canDownloadSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}},"riskScore":{"type":"number","description":"Risk score of this supplier's supply chain being 0 the lowest risk and 100 the highest risk.","default":null,"minimum":0,"maximum":100}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities","riskScore"]},"GetAnalysisBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"GetMostRecentAnalysesBaseDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]}},"required":["EUFOROBS","PRECISION"]},"GetAllGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'FeatureCollection'"},"features":{"type":"array","description":"A list of plots as GeoJSON Features.","items":{"oneOf":[{"$ref":"#/components/schemas/GetBaseGeoJsonPlotDto"},{"$ref":"#/components/schemas/GetFullGeoJsonPlotDto"}]}}},"required":["type","features"]},"GetBaseGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetBaseGeoJsonPlotPropertiesDto"}]}},"required":["type","id","geometry","properties"]},"GetPointDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Point' for points"},"coordinates":{"type":"array","description":"A Point's coordinates. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"number","minItems":2,"maxItems":3}}},"required":["type","coordinates"]},"GetBaseGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]},"GetFullGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetFullGeoJsonPlotPropertiesDto"}]}},"description":"Create a plot in GeoJSON format","required":["type","id","geometry","properties"]},"GetFullGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]}}},"paths":{"/plots":{"get":{"description":"Lists all plots of your business.","operationId":"PlotsController_findAllByBusiness","parameters":[{"name":"page","required":false,"in":"query","description":"Page number to retrieve.If you provide invalid value the default page number will applied\n

\n Example: 1\n

\n

\n Default Value: 1\n

\n ","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of records per page.\n

\n Example: 20\n

\n

\n Default Value: 100\n

\n

\n Max Value: 500\n

\n\n If provided value is greater than max value, max value will be applied.\n ","schema":{"type":"number"}},{"name":"filter.commodities","required":false,"in":"query","description":"Filter by commodities query param.\n

\n Format: filter.commodities={$not}:OPERATION:VALUE\n

\n

\n Example: filter.commodities=$not:$like:John Doe&filter.commodities=like:John\n

\n

Available Operations

","schema":{"type":"array","items":{"type":"string"}}},{"name":"sortBy","required":false,"in":"query","description":"Parameter to sort by.\n

To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting

\n

\n Format: fieldName:DIRECTION\n

\n

\n Example: sortBy=id:DESC&sortBy=createdAt:ASC\n

\n

\n Default Value: createdAt:DESC\n

\n

Available Fields

\n ","schema":{"type":"array","items":{"type":"string","enum":["createdAt:ASC","createdAt:DESC"]}}},{"name":"select","required":false,"in":"query","description":"List of fields to select.\n

\n Example: \n

\n

\n Default Value: By default all fields returns. If you want to select only some fields, provide them in query param\n

\n ","schema":{"type":"string"}},{"name":"includes","required":false,"in":"query","description":"A comma-separated list of relations to be included in the response. Possible relations are: mostRecentAnalysis, suppliers, mostRecentAnalysesByType, riskLevel.\n Deprecation: 'mostRecentAnalysis' is deprecated. Please use 'mostRecentAnalysesByType' as the response data will in particular include the data from 'mostRecentAnalysis'.","schema":{}},{"name":"accept","in":"header","description":"Specify the response format. Defaults to application/json.","schema":{"type":"string","enum":["application/json","application/geo+json"]}}],"responses":{"200":{"description":"All plots in a list or as a GeoJSON FeatureCollection","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/GetPlotBaseDto"},{"$ref":"#/components/schemas/GetPlotFullDto"}]}}},"application/geo+json":{"schema":{"$ref":"#/components/schemas/GetAllGeoJsonPlotDto"}}}},"401":{"description":""},"403":{"description":""},"501":{"description":"Using the query parameter 'includes' with 'mostRecentAnalysesByType' and 'mostRecentAnalysis' simultaneously is not supported. 'mostRecentAnalysis' is deprecated. Please only use 'mostRecentAnalysesByType' as the response data will in particular include the data from 'mostRecentAnalysis'."}},"summary":"List all plots.","tags":["Plots"]}}}} ``` * Lists all plots of your business with pagination support * Supports includes: * `mostRecentAnalysis` (deprecated) - returns the latest analysis for a plot * `mostRecentAnalysesByType` - returns the latest precision and latest os analysis for a plot * `suppliers` - result will include plots of suppliers and sub-suppliers. * Supports pagination * Support filtering by `commodity` * Support sorting by `createdAt` * Response format can be set with Accept header to either `application/json` (default) or `application/geo+json` for GeoJSON format * **Note**: Using both `mostRecentAnalysis` and `mostRecentAnalysesByType` in includes simultaneously is not supported. ## Create a plot. > Create a plot owned by your business using JSON or GeoJSON format. ```json {"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.44.2"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreatePlotDto":{"type":"object","properties":{"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"description":{"type":"string","description":"Short description to find and identify plots as owners."},"geometry":{"type":"object","description":"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."},"countryCode":{"type":"string","description":"Deprecated. This will be automatically populated by the system.\n The country code (ISO 31661Alpha2 expected).","deprecated":true},"isActive":{"type":"boolean","description":"Is this plot active in the system","default":true},"filename":{"type":"string","description":"Filename of the file where the plot is defined"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "},"areaHa":{"type":"number","description":"The area of the plot or production place in hectares (ha).\n\n Only applicable when the geometry is a GeoJSON point.\n - must be between 0.01 and 4 hectares\n - defaults to 4 hectares if not specified\n\n If the geometry is a polygon, this value will be ignored as the area is calculated from the polygon itself","default":4,"minimum":0.1,"maximum":4}},"required":["commodities","name","geometry"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"CreateGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/CreateGeoJsonPlotPropertiesDto"}]}},"description":"Create a plot in GeoJSON format","required":["type","geometry","properties"]},"GetPointDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Point' for points"},"coordinates":{"type":"array","description":"A Point's coordinates. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"number","minItems":2,"maxItems":3}}},"required":["type","coordinates"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"CreateGeoJsonPlotPropertiesDto":{"type":"object","properties":{"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"description":{"type":"string","description":"Short description to find and identify plots as owners."},"countryCode":{"type":"string","description":"Deprecated. This will be automatically populated by the system.\n The country code (ISO 31661Alpha2 expected).","deprecated":true},"isActive":{"type":"boolean","description":"Is this plot active in the system","default":true},"filename":{"type":"string","description":"Filename of the file where the plot is defined"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "},"areaHa":{"type":"number","description":"The area of the plot or production place in hectares (ha).\n\n Only applicable when the geometry is a GeoJSON point.\n - must be between 0.01 and 4 hectares\n - defaults to 4 hectares if not specified\n\n If the geometry is a polygon, this value will be ignored as the area is calculated from the polygon itself","default":4,"minimum":0.1,"maximum":4}},"required":["commodities","name"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","sentByUser","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view surveys"},"canViewOwnedSurveyResponses":{"type":"boolean","default":true,"description":"Indicates whether the user can view the survey responses owned by their business"},"canViewSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the survey responses of their tier-1 suppliers"},"canMutateOwnedSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can update or delete survey responses or create a new survey response owned by their business"},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own survey responses or the completed survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewSurveys","canViewOwnedSurveyResponses","canViewSurveyResponsesOfTier1Suppliers","canMutateOwnedSurveyResponses","canDownloadSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}},"riskScore":{"type":"number","description":"Risk score of this supplier's supply chain being 0 the lowest risk and 100 the highest risk.","default":null,"minimum":0,"maximum":100}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities","riskScore"]},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n This field is deprecated and will be removed in the future. Please use\n customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"GetFullGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetFullGeoJsonPlotPropertiesDto"}]}},"description":"Create a plot in GeoJSON format","required":["type","id","geometry","properties"]},"GetFullGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]}}},"paths":{"/plots":{"post":{"description":"Create a plot owned by your business using JSON or GeoJSON format.","operationId":"PlotsController_create","parameters":[{"name":"accept","in":"header","description":"Specify the response format. Defaults to application/json.","schema":{"type":"string","enum":["application/json","application/geo+json"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreatePlotDto"},{"$ref":"#/components/schemas/CreateGeoJsonPlotDto"}]}},"application/geo+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreatePlotDto"},{"$ref":"#/components/schemas/CreateGeoJsonPlotDto"}]}}}},"responses":{"201":{"description":"Returns the created plot","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlotFullDto"}},"application/geo+json":{"schema":{"$ref":"#/components/schemas/GetFullGeoJsonPlotDto"}}}},"401":{"description":""},"403":{"description":""}},"summary":"Create a plot.","tags":["Plots"]}}}} ``` * Creates a single plot owned by the user's business * Request format can be set with `Content-Type` header and should adhere to * `Content-Type=application/json` (default) or * `Content-Type=application/geo+json` for payloads in GeoJSON format. * Response format can be set with `Accept` header to either `application/json` (default) or `application/geo+json` for GeoJSON format ## Retrieve a plot. > Retrieve the specified plot. ```json {"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.44.2"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetPlotBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n This field is deprecated and will be removed in the future. Please use\n customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","sentByUser","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view surveys"},"canViewOwnedSurveyResponses":{"type":"boolean","default":true,"description":"Indicates whether the user can view the survey responses owned by their business"},"canViewSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the survey responses of their tier-1 suppliers"},"canMutateOwnedSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can update or delete survey responses or create a new survey response owned by their business"},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own survey responses or the completed survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewSurveys","canViewOwnedSurveyResponses","canViewSurveyResponsesOfTier1Suppliers","canMutateOwnedSurveyResponses","canDownloadSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}},"riskScore":{"type":"number","description":"Risk score of this supplier's supply chain being 0 the lowest risk and 100 the highest risk.","default":null,"minimum":0,"maximum":100}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities","riskScore"]},"GetAnalysisBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"GetMostRecentAnalysesBaseDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]}},"required":["EUFOROBS","PRECISION"]},"GetFullGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetFullGeoJsonPlotPropertiesDto"}]}},"description":"Create a plot in GeoJSON format","required":["type","id","geometry","properties"]},"GetPointDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Point' for points"},"coordinates":{"type":"array","description":"A Point's coordinates. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"number","minItems":2,"maxItems":3}}},"required":["type","coordinates"]},"GetFullGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]},"GetBaseGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetBaseGeoJsonPlotPropertiesDto"}]}},"required":["type","id","geometry","properties"]},"GetBaseGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]}}},"paths":{"/plots/{id}":{"get":{"description":"Retrieve the specified plot.","operationId":"PlotsController_findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"includes","required":false,"in":"query","description":"A comma-separated list of relations to be included in the response.\n Possible relations are: mostRecentAnalysis, mostRecentAnalysesByType, riskLevel.","schema":{}},{"name":"accept","in":"header","description":"Specify the response format. Defaults to application/json.","schema":{"type":"string","enum":["application/json","application/geo+json"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetPlotBaseDto"},{"$ref":"#/components/schemas/GetPlotFullDto"}]}},"application/geo+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetFullGeoJsonPlotDto"},{"$ref":"#/components/schemas/GetBaseGeoJsonPlotDto"}]}}},"description":""},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"Retrieve a plot.","tags":["Plots"]}}}} ``` * Retrieves a specific plot by UUID * Supports includes: * `mostRecentAnalysis` * Response format can be set with Accept header to either `application/json` (default) or `application/geo+json` for GeoJSON format ## Update a plot. > Update the properties of the specified plot. Handles updates partially, i.e. properties missing in the request body will not be changed. ```json {"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.44.2"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdatePlotDto":{"type":"object","properties":{"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"description":{"type":"string","description":"Short description to find and identify plots as owners."},"geometry":{"type":"object","description":"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."},"countryCode":{"type":"string","description":"Deprecated. This will be automatically populated by the system.\n The country code (ISO 31661Alpha2 expected).","deprecated":true},"isActive":{"type":"boolean","description":"Is this plot active in the system","default":true},"filename":{"type":"string","description":"Filename of the file where the plot is defined"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "},"areaHa":{"type":"number","description":"The area of the plot or production place in hectares (ha).\n\n Only applicable when the geometry is a GeoJSON point.\n - must be between 0.01 and 4 hectares\n - defaults to 4 hectares if not specified\n\n If the geometry is a polygon, this value will be ignored as the area is calculated from the polygon itself","default":4,"minimum":0.1,"maximum":4}}},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","sentByUser","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view surveys"},"canViewOwnedSurveyResponses":{"type":"boolean","default":true,"description":"Indicates whether the user can view the survey responses owned by their business"},"canViewSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the survey responses of their tier-1 suppliers"},"canMutateOwnedSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can update or delete survey responses or create a new survey response owned by their business"},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own survey responses or the completed survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewSurveys","canViewOwnedSurveyResponses","canViewSurveyResponsesOfTier1Suppliers","canMutateOwnedSurveyResponses","canDownloadSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}},"riskScore":{"type":"number","description":"Risk score of this supplier's supply chain being 0 the lowest risk and 100 the highest risk.","default":null,"minimum":0,"maximum":100}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities","riskScore"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n This field is deprecated and will be removed in the future. Please use\n customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"GetFullGeoJsonPlotDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the geojson object. Always 'Feature' for geojson plots."},"id":{"type":"string","description":"The id of the plot."},"geometry":{"description":"A GeoJSON geometry object as defined in https://datatracker.ietf.org/doc/html/rfc7946","oneOf":[{"$ref":"#/components/schemas/GetPointDto"},{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"properties":{"description":"The properties of the geojson plot.","allOf":[{"$ref":"#/components/schemas/GetFullGeoJsonPlotPropertiesDto"}]}},"description":"Create a plot in GeoJSON format","required":["type","id","geometry","properties"]},"GetPointDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Point' for points"},"coordinates":{"type":"array","description":"A Point's coordinates. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"number","minItems":2,"maxItems":3}}},"required":["type","coordinates"]},"GetFullGeoJsonPlotPropertiesDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n May be multiple if the plot is reachable in the supply chain\n via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n 'includes'. If no analysis on this plot is available yet, this\n property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n If no analysis on this plot is available yet, this property may be null."},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n Constraints:\n - Up to 10 keys per object\n - Key length: Maximum 255 characters\n - String value length: Maximum 255 characters\n - Values must be of type: string, number, or boolean\n - Nested objects are not allowed\n - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n "}},"required":["id","createdAt","updatedAt","commodities","name","surfaceArea","countryCode"]}}},"paths":{"/plots/{id}":{"patch":{"description":"Update the properties of the specified plot. Handles updates partially, i.e. properties missing in the request body will not be changed.","operationId":"PlotsController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"accept","in":"header","description":"Specify the response format. Defaults to application/json.","schema":{"type":"string","enum":["application/json","application/geo+json"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlotDto"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlotFullDto"}},"application/geo+json":{"schema":{"$ref":"#/components/schemas/GetFullGeoJsonPlotDto"}}},"description":""},"401":{"description":""},"403":{"description":""}},"summary":"Update a plot.","tags":["Plots"]}}}} ``` * Updates an existing plot * Accepts only JSON payload with `Content-Type=application/json` * Response format can be set with Accept header to either `application/json` (default) or `application/geo+json` for GeoJSON format ## Delete a plot. > Deletes the specified plot. Uses soft-deletion instead of regular deletion to ensure auditability. There is currently no way to undo the soft-deletion via the API. ```json {"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.44.2"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/plots/{id}":{"delete":{"description":"Deletes the specified plot. Uses soft-deletion instead of regular deletion to ensure auditability. There is currently no way to undo the soft-deletion via the API.","operationId":"PlotsController_softRemove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"401":{"description":""},"403":{"description":""},"404":{"description":""},"500":{"description":""}},"summary":"Delete a plot.","tags":["Plots"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.live-eo.com/tradeaware/using-the-tradeaware-api/api-reference/plots.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.