move

post

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

Re-link a source record to a different record, or detach it into a newly created one.

Re-links the source record to toRecordId, or detaches it into a newly created golden record (createRecord: true). Source data never changes.

The request fails if you are attempting to unlink the only source record from a golden record. Instead, use merge records to merge the golden record into the target golden record.

Important Notes

Use fromRecordId as a guard against concurrent link changes.
disableRecordUpdate affects both golden records. If set to true, neither the original nor the source golden record is reconsolidated.
disablePreviousRecordUpdate affects only the golden record from which the source record has been moved. If set to true, the golden record from which the source record has been moved is not reconsolidated.
Set either disableRecordUpdate or disablePreviousRecordUpdate. These parameters cannot be combined.
Empty golden records are prevented. createRecord: true with disableRecordUpdate: true fails with a 400 error to prevent an empty golden record from being created.
Dry run with createRecord: The recordId is empty in the response. The version and timestamp fields are empty.

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. Where to move the source record, and options.

toRecordId

string

Re-link the source record to this existing record.

createRecord

boolean

Detach the source record into a newly created record, its data consolidated from the source record. Must be true when set. Cannot be combined with disable_record_update (INVALID_ARGUMENT; disable_previous_record_update is allowed), and requires the table to have a consolidation rule (FAILED_PRECONDITION otherwise). Also FAILED_PRECONDITION when the source record was written as SOURCE data from a source system the table's schema mapping no longer covers.

fromRecordId

string

If set, the move fails with FAILED_PRECONDITION unless the source record is currently linked to this record.

disablePreviousRecordUpdate

boolean

Do not update the data of the record the source record moves out of (the previous record). The record it moves into is still updated, so unlike disable_record_update this is valid with create_record. The move fails with FAILED_PRECONDITION if the record it moves into would exceed the consolidation maximum. Cannot be combined with disable_record_update (INVALID_ARGUMENT).

disableRecordUpdate

boolean

Do not update the data of either affected record: the one the source record moves out of or the one it moves into. Only valid with to_record_id: a record newly created by create_record is always consolidated, so this flag with create_record is INVALID_ARGUMENT. Without it, a move that would update a record over the consolidation maximum fails with FAILED_PRECONDITION and writes nothing; disable_previous_record_update avoids this only for the previous record.

dryRun

boolean

Compute and return the result without persisting anything. A move into a new record (create_record) reports the new record's record_id as empty, on both record and source_record: no record is created, and the id the real move mints is not known until it runs. A dry run with to_record_id reports that record id as normal.

Response

200A successful response.