get

https://api-examples.tamr.cloud/api/v1alpha1/tables/{tableId}/records/{recordId}

Fetch an individual record by its identifier, or by the compound id of one of its source records.

Note: To use the Try It feature on the right to see an example response, you can enter any values for the required parameters.

Using the recordId parameter, you can get a specific current or historical golden record by the following IDs associated with that record:

Record ID (the ID of the record in the RealTime datastore)
Tamr ID (the ID assigned by Tamr to the mastered entity and it's clustered source records)
External ID. This retrieves the goldenr record associated with a specific external ID.
Source record ID and source system name. This retrieves the golden record associated with a specific source record.

Notes for sourceSystemName:

The sourceSystemName parameter is applicable only when retrieving a golden record by a linked source record.
This parameter identifies the specific source system that the source record ID came from. It is necessary because the same source record ID can exist in different source systems (for example, in both a CRM and ERP system).

Path Params

tableId

string

required

Required. The table that the record belongs to.

recordId

string

required

Required. An identifier for the record to fetch. Can either be the primary key of the record, or an external ID. When source_system_name is set, this is instead read as a source record id within that system.

Query Params

sourceSystemName

string

Optional. The source system that record_id belongs to. When set, record_id is interpreted as a source record id within that system -- the compound id (source_system_name, record_id) -- and the (golden) record that source record links to is returned. The returned record's record_id is that golden record's own id, which is not the requested record_id.

Empty is equivalent to omitting it: record_id is read as a primary key or external ID. Source records written without a system name need no system name here, as their source record id is already an external ID of the record they link to.

Response

200A successful response.