update

put

https://api-examples.tamr.cloud/api/v1alpha1/projects/{projectId}/tables/{tableId}/sourceRecords/{sourceRecordId}

Replace a source record's data. Cannot change which record it is linked to — use move.

Replaces the source record's data. Use move to change the golden record link.

Important Notes:

Full replacement. Fields you omit from data are removed.
dataSchema defaults to TABLE if omitted.
If your source system is integrated with the data product via both the APIs and Tamr's workflows simultaneously, see notes for Hybrid Source Integration for additional considerations.

Path Params

projectId

string

required

tableId

string

required

sourceRecordId

string

required

The record's id within its source system.

Query Params

sourceSystemName

string

Qualifies source_record_id: the source system the record came from. Omit for records written without one.

Body Params

data

object

required

Full replacement of the source record's data (PUT semantics). Cannot change the linked record — use move. Interpreted per data_schema, matching create.

dataSchema

string

enum

Defaults to DATA_SCHEMA_UNSPECIFIED

How data is interpreted relative to the table schema; matches create's data_schema. Unset defaults to TABLE. May differ from the source record's previous write; the latest write's value governs the record's treatment at every future re-consolidation.

Allowed:

disableRecordUpdate

boolean

Do not re-consolidate the linked record; the source-record data is still replaced. Accepted no-op on tables without a consolidation rule.

This is also the supported way to update a source record whose linked record already has more linked source records than the consolidation maximum: such a record cannot be re-consolidated, so a plain update (this flag unset) fails FAILED_PRECONDITION and writes nothing. Set this flag to replace the source data while leaving the (un-re-consolidatable) record data unchanged.

dryRun

boolean

Compute and return the result without persisting anything.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.