Update a Plot Risk Assessment

Update a risk assessment of a plot

Update a plot risk assessment by id

patch

Update a plot risk assessment by id

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

statusstring · enumOptional

The status of the plot risk assessment

Default: NEWPossible values:

notesstring · max: 1000Optional

The notes of the plot risk assessment

Responses

200Success

application/json

400Error

401Error

403Error

404Error

patch

/plot-risk-assessments/{id}

HTTPcURLJavaScriptPython

PATCH /plot-risk-assessments/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "status": "NEW",
  "notes": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "NEW",
  "notes": "This is a note",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "plotId": "123e4567-e89b-12d3-a456-426614174000",
  "businessId": "123e4567-e89b-12d3-a456-426614174000",
  "plot": {
    "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": "[email protected]",
        "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": [
          "[Circular Reference]"
        ],
        "newlyCreated": "true",
        "members": [
          "[Circular Reference]"
        ],
        "connectionsAsSource": [
          "[Circular Reference]"
        ],
        "connectionsAsTarget": [
          "[Circular Reference]"
        ],
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "contactPerson": "[Circular Reference]",
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text",
        "tracesEnvironment": "ACCEPTANCE"
      }
    ],
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            100,
            0
          ],
          [
            100.01,
            0
          ],
          [
            100.01,
            0.01
          ],
          [
            100,
            0.01
          ],
          [
            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"
      }
    },
    "riskAssessmentStatus": "NEW"
  },
  "business": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "[email protected]",
    "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
              ],
              [
                100.01,
                0
              ],
              [
                100.01,
                0.01
              ],
              [
                100,
                0.01
              ],
              [
                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",
          "customData": {
            "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",
            "customData": {
              "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",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          }
        },
        "riskAssessmentStatus": "NEW",
        "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": "[email protected]",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveys": false,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canMutateOwnedSurveyResponses": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false
        }
      }
    ],
    "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": "[email protected]",
        "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": "[email protected]",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewSurveys": false,
        "canViewOwnedSurveyResponses": true,
        "canViewSurveyResponsesOfTier1Suppliers": false,
        "canMutateOwnedSurveyResponses": false,
        "canDownloadSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false,
        "canManageCmsSupplierRiskAssessmentStatuses": false
      }
    },
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text",
    "tracesEnvironment": "ACCEPTANCE"
  }
}