Skip to main content

Update Object Data

Update data for objects in the archives system.
Supports updating by object ID or by design ID and type.

PATCH/api/object

Updates object data. Can target a specific object by ID or update objects within a design by specifying design ID and type.

Parameters

NameTypeRequiredDescription
objectidstring-The unique identifier of the object to update (use either objectid OR designid + type)
designidstring-The design ID containing the objects to update (must be used with type parameter)
typestring-The type of objects to update within the design (must be used with designid parameter)
dataarrayArray of data points to update, each containing depthTVD, gradient, and value

Notes

  • You must provide either objectid OR both designid and type parameters - not both combinations
  • When updating by objectid, the update targets a specific object directly
  • When updating by designid and type, all objects of the specified type within the design are updated
  • Each data point in the data array must contain:
    • depthTVD: True Vertical Depth measurement
    • gradient: Gradient value (typically in specific gravity units)
    • value: The measurement value (typically in bar for pressure)
  • The update operation replaces all existing data points for the object(s)
  • The response includes version information to track changes over time
  • Units are implicit based on the object type and system configuration