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

Required. The project the table belongs to.

tableId

string

required

Required. The table the source record belongs to.

sourceRecordId

string

required

Required. The record's id within its source system.

Query Params

sourceSystemName

string

The source system the record came from. Omit for records written without one. Together with source_record_id it identifies the source record.

Body Params

Required. The replacement data and options.

data

object

required

Required. The source record's contents, interpreted according to data_schema. Replaces the existing data in full.

dataSchema

string

enum

Defaults to DATA_SCHEMA_UNSPECIFIED

How data is interpreted relative to the table schema. Unset defaults to TABLE (data already conforms; no mapping). SOURCE maps the data per the table's schema mapping for the source system. Applies to this source record until a later write changes it.

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. Without it, an update whose linked record is over the consolidation maximum fails with FAILED_PRECONDITION and writes nothing.

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.