TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Risk Assessment
    • Transaction Management
    • Document Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference

Plots

PreviousAuthNextAnalyses of a specific Plot

Last updated 9 months ago

Retrieve a plot.

get

Retrieve the specified plot.

Authorizations
Path parameters
idstringRequired
Query parameters
includesanyOptional

A comma-separated list of relations to be included in the response. Possible relations are: mostRecentAnalysis.

Example: mostRecentAnalysis
Responses
200Success
application/json
Responseone of
or
401Error
403Error
404Error
get
GET /plots/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "createdAt": "2023‐07‐26T15:03:48Z",
  "updatedAt": "2023‐07‐28T09:13:37Z",
  "suppliers": [
    {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023‐07‐26T15:03:48Z",
          "updatedAt": "2023‐07‐28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  101,
                  0
                ],
                [
                  101,
                  1
                ],
                [
                  100,
                  1
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "started",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "EUFOROBS",
            "metadata": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": true,
            "canManageTransactions": true,
            "canViewSurveys": true,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": true,
            "canMutateOwnedSurveyResponses": true,
            "canDownloadSurveyResponses": true,
            "canManageWebhooks": true
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": true,
          "canManageTransactions": true,
          "canViewSurveys": true,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": true,
          "canMutateOwnedSurveyResponses": true,
          "canDownloadSurveyResponses": true,
          "canManageWebhooks": true
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    }
  ],
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          100,
          0
        ],
        [
          101,
          0
        ],
        [
          101,
          1
        ],
        [
          100,
          1
        ],
        [
          100,
          0
        ]
      ]
    ]
  },
  "commodities": [
    "oil palm",
    "rubber"
  ],
  "name": "text",
  "surfaceArea": 1,
  "countryCode": "text",
  "mostRecentAnalysis": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "status": "started",
    "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "analysedAt": "2023-07-28T09:13:37Z",
    "version": "open-source-1.0.0",
    "deforestedArea": 123.45,
    "deforestedGeometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            13,
            52.5
          ],
          [
            13.5,
            52.5
          ],
          [
            13.5,
            52
          ],
          [
            13,
            52
          ],
          [
            13,
            52.5
          ]
        ]
      ]
    },
    "riskOfDeforestation": 0.3,
    "type": "EUFOROBS"
  },
  "mostRecentAnalysesByType": {
    "EUFOROBS": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS"
    },
    "PRECISION": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS"
    }
  }
}

Delete a plot.

delete

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.

Authorizations
Path parameters
idstringRequired
Responses
204Success
401Error
403Error
404Error
500Error
delete
DELETE /plots/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Accept: */*

No content
  • GETList all plots.
  • POSTCreate a plot.
  • GETRetrieve a plot.
  • PATCHUpdate a plot.
  • DELETEDelete a plot.

List all plots.

get

Lists all plots of your business.

Authorizations
Query parameters
pagenumberOptional

Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1

limitnumberOptional

Number of records per page. Example: 20 Default Value: 100 Max Value: 500 

  If provided value is greater than max value, max value will be applied.
filter.commoditiesstring[]Optional

Filter by commodities query param. Format: filter.commodities={$not}:OPERATION:VALUE Example: filter.commodities=$not:$like:John Doe&filter.commodities=like:John Available Operations$contains

selectstringOptional

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

includesanyOptional

A comma-separated list of relations to be included in the response. Possible relations are: mostRecentAnalysis, suppliers, mostRecentAnalysesByType. Deprecation: 'mostRecentAnalysis' is deprecated. Please use 'mostRecentAnalysesByType' as the response data will in particular include the data from 'mostRecentAnalysis'.

Example: mostRecentAnalysesByType
Responses
200
A list of all plots
application/json
401Error
403Error
501
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'.
get
GET /plots HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "createdAt": "2023‐07‐26T15:03:48Z",
    "updatedAt": "2023‐07‐28T09:13:37Z",
    "suppliers": [
      {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "email": "user@example.com",
        "name": "Example Inc.",
        "username": "John Doe",
        "addressStreet": "Salawati 143",
        "addressZip": "98451",
        "addressPostcode": "12345",
        "addressArea": "Brandenburg",
        "addressCity": "West Papua",
        "addressCountryCode": "ID",
        "addressCountry": "Indonesia",
        "addressLine1": "Salawati 123",
        "addressLine2": "3rd floor",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "initialLocale": "id-ID",
        "units": "metric",
        "plots": [
          {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023‐07‐26T15:03:48Z",
            "updatedAt": "2023‐07‐28T09:13:37Z",
            "suppliers": "[Circular Reference]",
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    100,
                    0
                  ],
                  [
                    101,
                    0
                  ],
                  [
                    101,
                    1
                  ],
                  [
                    100,
                    1
                  ],
                  [
                    100,
                    0
                  ]
                ]
              ]
            },
            "commodities": [
              "oil palm",
              "rubber"
            ],
            "name": "text",
            "surfaceArea": 1,
            "countryCode": "text",
            "mostRecentAnalysis": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            },
            "mostRecentAnalysesByType": {
              "EUFOROBS": {
                "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
                "createdAt": "2023-07-26T15:03:48Z",
                "updatedAt": "2023-07-28T09:13:37Z",
                "status": "started",
                "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
                "analysedAt": "2023-07-28T09:13:37Z",
                "version": "open-source-1.0.0",
                "deforestedArea": 123.45,
                "deforestedGeometry": {
                  "type": "Polygon",
                  "coordinates": [
                    [
                      [
                        13,
                        52.5
                      ],
                      [
                        13.5,
                        52.5
                      ],
                      [
                        13.5,
                        52
                      ],
                      [
                        13,
                        52
                      ],
                      [
                        13,
                        52.5
                      ]
                    ]
                  ]
                },
                "riskOfDeforestation": 0.3,
                "type": "EUFOROBS",
                "metadata": {
                  "some": "metadata"
                },
                "name": "text"
              },
              "PRECISION": {
                "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
                "createdAt": "2023-07-26T15:03:48Z",
                "updatedAt": "2023-07-28T09:13:37Z",
                "status": "started",
                "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
                "analysedAt": "2023-07-28T09:13:37Z",
                "version": "open-source-1.0.0",
                "deforestedArea": 123.45,
                "deforestedGeometry": {
                  "type": "Polygon",
                  "coordinates": [
                    [
                      [
                        13,
                        52.5
                      ],
                      [
                        13.5,
                        52.5
                      ],
                      [
                        13.5,
                        52
                      ],
                      [
                        13,
                        52
                      ],
                      [
                        13,
                        52.5
                      ]
                    ]
                  ]
                },
                "riskOfDeforestation": 0.3,
                "type": "EUFOROBS",
                "metadata": {
                  "some": "metadata"
                },
                "name": "text"
              }
            },
            "filename": {},
            "description": "text",
            "ownerId": "text",
            "customData": {
              "key1": "someValue",
              "key2": true,
              "key3": 1234
            }
          }
        ],
        "newlyCreated": "true",
        "members": [
          {
            "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
            "business": "[Circular Reference]",
            "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "firstName": "Paul",
            "lastName": "Smith",
            "locale": "id-ID",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "completed": "false",
            "businessInvitations": "[Circular Reference]",
            "userInvitations": "[Circular Reference]",
            "email": "user@example.com",
            "consentedAt": "2023-07-28T09:13:37Z",
            "entitlements": {
              "canTriggerPrecisionAnalysis": true,
              "canManageTransactions": true,
              "canViewSurveys": true,
              "canViewOwnedSurveyResponses": true,
              "canViewSurveyResponsesOfTier1Suppliers": true,
              "canMutateOwnedSurveyResponses": true,
              "canDownloadSurveyResponses": true,
              "canManageWebhooks": true
            }
          }
        ],
        "connectionsAsSource": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "sourceBusiness": "[Circular Reference]",
            "targetBusiness": "[Circular Reference]",
            "createdAt": "2021-01-01T00:00:00.000Z",
            "updatedAt": "2021-01-01T00:00:00.000Z",
            "customData": {
              "foo": "bar"
            },
            "plotsCount": 1,
            "plotsCommodities": [
              "cattle",
              "cocoa"
            ]
          }
        ],
        "connectionsAsTarget": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "sourceBusiness": "[Circular Reference]",
            "targetBusiness": "[Circular Reference]",
            "createdAt": "2021-01-01T00:00:00.000Z",
            "updatedAt": "2021-01-01T00:00:00.000Z",
            "customData": {
              "foo": "bar"
            },
            "plotsCount": 1,
            "plotsCommodities": [
              "cattle",
              "cocoa"
            ]
          }
        ],
        "businessInvitations": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "sentByUser": "[Circular Reference]",
            "business": "[Circular Reference]",
            "email": "user@example.com",
            "status": "PENDING",
            "createdAt": "2020-01-01T00:00:00.000Z",
            "updatedAt": "2020-01-01T00:00:00.000Z",
            "sourceIsInvitee": "true",
            "customData": {
              "key1": "someValue",
              "key2": true,
              "key3": 1234
            }
          }
        ],
        "contactPerson": {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": true,
            "canManageTransactions": true,
            "canViewSurveys": true,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": true,
            "canMutateOwnedSurveyResponses": true,
            "canDownloadSurveyResponses": true,
            "canManageWebhooks": true
          }
        },
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text"
      }
    ],
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    },
    "commodities": [
      "oil palm",
      "rubber"
    ],
    "name": "text",
    "surfaceArea": 1,
    "countryCode": "text",
    "mostRecentAnalysis": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS"
    },
    "mostRecentAnalysesByType": {
      "EUFOROBS": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "status": "started",
        "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "analysedAt": "2023-07-28T09:13:37Z",
        "version": "open-source-1.0.0",
        "deforestedArea": 123.45,
        "deforestedGeometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                13,
                52.5
              ],
              [
                13.5,
                52.5
              ],
              [
                13.5,
                52
              ],
              [
                13,
                52
              ],
              [
                13,
                52.5
              ]
            ]
          ]
        },
        "riskOfDeforestation": 0.3,
        "type": "EUFOROBS"
      },
      "PRECISION": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "status": "started",
        "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "analysedAt": "2023-07-28T09:13:37Z",
        "version": "open-source-1.0.0",
        "deforestedArea": 123.45,
        "deforestedGeometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                13,
                52.5
              ],
              [
                13.5,
                52.5
              ],
              [
                13.5,
                52
              ],
              [
                13,
                52
              ],
              [
                13,
                52.5
              ]
            ]
          ]
        },
        "riskOfDeforestation": 0.3,
        "type": "EUFOROBS"
      }
    }
  }
]

Create a plot.

post

Create a plot owned by your business.

Authorizations
Body
namestringRequired

Free text name of the plot. Useful for easily finding and identifying the plot as an enduser.

descriptionstringOptional

Short description to find and identify plots as owners.

geometryall ofRequired

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.

Example: {"type":"Polygon","coordinates":[[[100,0],[101,0],[101,1],[100,1],[100,0]]]}
countryCodestringOptionalDeprecated

Deprecated. This will be automatically populated by the system. The country code (ISO 31661Alpha2 expected).

isActivebooleanOptional

Is this plot active in the system

Default: true
filenamestringOptional

Filename of the file where the plot is defined

customDataobjectOptional

A customizable metadata field for storing additional information related to a plot in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.

  The `customData` field is returned unchanged and is visible only to the owners of the plot.

  Constraints:
    - Up to 10 keys per object
    - Key length: Maximum 255 characters
    - String value length: Maximum 255 characters
    - Values must be of type: string, number, or boolean
    - Nested objects are not allowed
    - Keys cannot contain: '__proto__', 'constructor', or 'prototype'
Example: {"key1":"someValue","key2":true,"key3":1234}
Responses
201Success
application/json
400Error
401Error
403Error
post
POST /plots HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "commodities": [
    "oil palm",
    "rubber"
  ],
  "name": "text",
  "description": "text",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          100,
          0
        ],
        [
          101,
          0
        ],
        [
          101,
          1
        ],
        [
          100,
          1
        ],
        [
          100,
          0
        ]
      ]
    ]
  },
  "isActive": true,
  "filename": "text",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}
{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "createdAt": "2023‐07‐26T15:03:48Z",
  "updatedAt": "2023‐07‐28T09:13:37Z",
  "suppliers": [
    {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023‐07‐26T15:03:48Z",
          "updatedAt": "2023‐07‐28T09:13:37Z",
          "suppliers": [
            "[Circular Reference]"
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  101,
                  0
                ],
                [
                  101,
                  1
                ],
                [
                  100,
                  1
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "started",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "EUFOROBS",
            "metadata": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": [
            "[Circular Reference]"
          ],
          "userInvitations": [
            "[Circular Reference]"
          ],
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": true,
            "canManageTransactions": true,
            "canViewSurveys": true,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": true,
            "canMutateOwnedSurveyResponses": true,
            "canDownloadSurveyResponses": true,
            "canManageWebhooks": true
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": true,
          "canManageTransactions": true,
          "canViewSurveys": true,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": true,
          "canMutateOwnedSurveyResponses": true,
          "canDownloadSurveyResponses": true,
          "canManageWebhooks": true
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    }
  ],
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          100,
          0
        ],
        [
          101,
          0
        ],
        [
          101,
          1
        ],
        [
          100,
          1
        ],
        [
          100,
          0
        ]
      ]
    ]
  },
  "commodities": [
    "oil palm",
    "rubber"
  ],
  "name": "text",
  "surfaceArea": 1,
  "countryCode": "text",
  "mostRecentAnalysis": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "status": "started",
    "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "analysedAt": "2023-07-28T09:13:37Z",
    "version": "open-source-1.0.0",
    "deforestedArea": 123.45,
    "deforestedGeometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            13,
            52.5
          ],
          [
            13.5,
            52.5
          ],
          [
            13.5,
            52
          ],
          [
            13,
            52
          ],
          [
            13,
            52.5
          ]
        ]
      ]
    },
    "riskOfDeforestation": 0.3,
    "type": "EUFOROBS",
    "metadata": {
      "some": "metadata"
    },
    "name": "text"
  },
  "mostRecentAnalysesByType": {
    "EUFOROBS": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS",
      "metadata": {
        "some": "metadata"
      },
      "name": "text"
    },
    "PRECISION": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS",
      "metadata": {
        "some": "metadata"
      },
      "name": "text"
    }
  },
  "filename": {},
  "description": "text",
  "ownerId": "text",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}

Update a plot.

patch

Update the properties of the specified plot. Handles updates partially, i.e. properties missing in the request body will not be changed.

Authorizations
Path parameters
idstringRequired
Body
namestringOptional

Free text name of the plot. Useful for easily finding and identifying the plot as an enduser.

descriptionstringOptional

Short description to find and identify plots as owners.

geometryall ofOptional

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.

Example: {"type":"Polygon","coordinates":[[[100,0],[101,0],[101,1],[100,1],[100,0]]]}
countryCodestringOptionalDeprecated

Deprecated. This will be automatically populated by the system. The country code (ISO 31661Alpha2 expected).

isActivebooleanOptional

Is this plot active in the system

Default: true
filenamestringOptional

Filename of the file where the plot is defined

customDataobjectOptional

A customizable metadata field for storing additional information related to a plot in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.

  The `customData` field is returned unchanged and is visible only to the owners of the plot.

  Constraints:
    - Up to 10 keys per object
    - Key length: Maximum 255 characters
    - String value length: Maximum 255 characters
    - Values must be of type: string, number, or boolean
    - Nested objects are not allowed
    - Keys cannot contain: '__proto__', 'constructor', or 'prototype'
Example: {"key1":"someValue","key2":true,"key3":1234}
Responses
200Success
application/json
401Error
403Error
404Error
patch
PATCH /plots/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "commodities": [
    "oil palm",
    "rubber"
  ],
  "name": "text",
  "description": "text",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          100,
          0
        ],
        [
          101,
          0
        ],
        [
          101,
          1
        ],
        [
          100,
          1
        ],
        [
          100,
          0
        ]
      ]
    ]
  },
  "isActive": true,
  "filename": "text",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}
{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "createdAt": "2023‐07‐26T15:03:48Z",
  "updatedAt": "2023‐07‐28T09:13:37Z",
  "suppliers": [
    {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023‐07‐26T15:03:48Z",
          "updatedAt": "2023‐07‐28T09:13:37Z",
          "suppliers": [
            "[Circular Reference]"
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  101,
                  0
                ],
                [
                  101,
                  1
                ],
                [
                  100,
                  1
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "started",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "EUFOROBS",
            "metadata": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "started",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "EUFOROBS",
              "metadata": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": [
            "[Circular Reference]"
          ],
          "userInvitations": [
            "[Circular Reference]"
          ],
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": true,
            "canManageTransactions": true,
            "canViewSurveys": true,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": true,
            "canMutateOwnedSurveyResponses": true,
            "canDownloadSurveyResponses": true,
            "canManageWebhooks": true
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": true,
          "canManageTransactions": true,
          "canViewSurveys": true,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": true,
          "canMutateOwnedSurveyResponses": true,
          "canDownloadSurveyResponses": true,
          "canManageWebhooks": true
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    }
  ],
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          100,
          0
        ],
        [
          101,
          0
        ],
        [
          101,
          1
        ],
        [
          100,
          1
        ],
        [
          100,
          0
        ]
      ]
    ]
  },
  "commodities": [
    "oil palm",
    "rubber"
  ],
  "name": "text",
  "surfaceArea": 1,
  "countryCode": "text",
  "mostRecentAnalysis": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "status": "started",
    "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "analysedAt": "2023-07-28T09:13:37Z",
    "version": "open-source-1.0.0",
    "deforestedArea": 123.45,
    "deforestedGeometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            13,
            52.5
          ],
          [
            13.5,
            52.5
          ],
          [
            13.5,
            52
          ],
          [
            13,
            52
          ],
          [
            13,
            52.5
          ]
        ]
      ]
    },
    "riskOfDeforestation": 0.3,
    "type": "EUFOROBS",
    "metadata": {
      "some": "metadata"
    },
    "name": "text"
  },
  "mostRecentAnalysesByType": {
    "EUFOROBS": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS",
      "metadata": {
        "some": "metadata"
      },
      "name": "text"
    },
    "PRECISION": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "status": "started",
      "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "analysedAt": "2023-07-28T09:13:37Z",
      "version": "open-source-1.0.0",
      "deforestedArea": 123.45,
      "deforestedGeometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              13,
              52.5
            ],
            [
              13.5,
              52.5
            ],
            [
              13.5,
              52
            ],
            [
              13,
              52
            ],
            [
              13,
              52.5
            ]
          ]
        ]
      },
      "riskOfDeforestation": 0.3,
      "type": "EUFOROBS",
      "metadata": {
        "some": "metadata"
      },
      "name": "text"
    }
  },
  "filename": {},
  "description": "text",
  "ownerId": "text",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}