v1

latestOpenAPI 3.0.32026-07-17291237.2 KB

Encounters

Update encounter fields

Apply JSON Patch operations (RFC 6902) to modify encounter fields. Supports operations: add, remove, replace, move, copy.

Common updatable fields include: genus, specificEpithet, year, month, day, sex, lifeStage, country, locationId, verbatimLocality, decimalLatitude, decimalLongitude, individualId, occurrenceId, behavior, and more.

Special fields like acousticTag, satelliteTag, metalTags, measurements, and assets can also be modified. Some fields (genus, specificEpithet, year, submitterID) cannot be removed.

patch/api/v3/encounters/{encounterId}

Path parameters

encounterIdstring uuid required

Encounter UUID

Request body

op'add' | 'remove' | 'replace' | 'move' | 'copy' required

The operation to perform

pathstring required

JSON Pointer to the field to modify. Supported paths for Encounters include: individualId, occurrenceId, assets, acousticTag, satelliteTag, metalTags, measurements, annotations, and standard encounter fields (genus, specificEpithet, year, month, day, hour, minutes, sex, lifeStage, country, locationId, verbatimLocality, decimalLatitude, decimalLongitude, behavior, etc.)

{"stackTrail":"components:schemas:PatchOperation:properties:value","oasType":"schema","type":"unknown","description":"The value for add/replace operations (type depends on the path)"}

fromstring

Source path for move/copy operations

Example request

[
  {
    "path": "/locationId"
  }
]

Response

Patch applied successfully

successboolean

statusCodeinteger