Update a frame spatial annotation

PATCH

/v1/datasets/{datasetId}/frame-spatial-annotations/{annotationId}

curl -X PATCH 'https://api.embodiflow.io/v1/datasets/{datasetId}/frame-spatial-annotations/{annotationId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "datasetVersionId": "00000000-0000-0000-0000-000000000000",
    "datasetVersionFileId": "00000000-0000-0000-0000-000000000000",
    "frameIndex": 0,
    "frameStampSec": 0,
    "frameStampNsec": 0,
    "timeReference": "string",
    "datasetClassId": "00000000-0000-0000-0000-000000000000",
    "className": "string",
    "trackId": "string",
    "trackKey": "string",
    "bboxX": 0,
    "bboxY": 0,
    "bboxWidth": 0,
    "bboxHeight": 0,
    "occluded": true,
    "truncated": true,
    "reviewStatus": "string",
    "status": "string",
    "attributesJson": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

datasetIdstringrequired
annotationIdstringrequired

Header parameters

If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

Request body

Content-Typeapplication/json

datasetVersionIdstring (uuid) | null
datasetVersionFileIdstring (uuid)
frameIndexnumber
frameStampSecnumber | null
frameStampNsecnumber | null
timeReferencestring
datasetClassIdstring (uuid) | null
classNamestring | null
trackIdstring | null
trackKeystring | null
bboxXnumber
bboxYnumber
bboxWidthnumber
bboxHeightnumber
occludedboolean | null
truncatedboolean | null
reviewStatusstring
statusstring
attributesJsonobject | null

Responses

Success

dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- datasetIdstringrequired
- datasetVersionIdstring | nullrequired
- datasetVersionFileIdstringrequired
- frameIndexnumberrequired
- frameStampSecnumber | nullrequired
- frameStampNsecnumber | nullrequired
- timeReferencestringrequired
- datasetClassIdstring | nullrequired
- classNamestring | nullrequired
- trackIdstring | nullrequired
- trackKeystring | nullrequired
- bboxXnumberrequired
- bboxYnumberrequired
- bboxWidthnumberrequired
- bboxHeightnumberrequired
- occludedone of | nullrequired
- truncatedone of | nullrequired
- reviewStatusstringrequired
- statusstringrequired
- publishedSnapshotIdstring | nullrequired
- createdBystring | nullrequired
- updatedBystring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- deletedAtstring | nullrequired
- attributesJsonobject | nullrequired

Response example

{
  "data": {
    "id": "string",
    "tenantId": "string",
    "projectId": "string",
    "datasetId": "string",
    "datasetVersionId": "string",
    "datasetVersionFileId": "string",
    "frameIndex": 0,
    "frameStampSec": 0,
    "frameStampNsec": 0,
    "timeReference": "string",
    "datasetClassId": "string",
    "className": "string",
    "trackId": "string",
    "trackKey": "string",
    "bboxX": 0,
    "bboxY": 0,
    "bboxWidth": 0,
    "bboxHeight": 0,
    "occluded": false,
    "truncated": false,
    "reviewStatus": "string",
    "status": "string",
    "publishedSnapshotId": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string",
    "attributesJson": {}
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1