Version: v1apha1

Initial Release 2024-04-12

Stability Level Early Access

See Versioning for more information on Tamr's API versioning policies.

Changelog:

Change Summary	Type	Date
Updated get record response body For more information on the updated response body, see the v1alpha1 change details secton below.	Breaking	2024-08-19
Updated get record response body For more information on the updated response body, see the v1alpha1 change details secton below.	Additive	2024-08-05
New merge records endpoint Use this endpoint to merge two specified records	Additive	2024-07-25
Updated update records endpoint to include external IDs A new optional body parameter is available, `externalIds`. Use this parameter to specify up to 5 IDs to link to the record.	Additive	2024-07-12

v1alpha1 Change Details

2024-08-19: Updated get record response body

Breaking change

This is the second of two planned changes to make the get record response format consistent with the response format for other record endpoints, in which all response parameters are included inside of a record object.

The first change was released on August 5, 2024 as an additive change. With this second change, the new response format is enforced.

Previous response:

{
  "tableId": "string",
  "recordId": "string",
  "versionId": "string",
  "createTime": "2024-08-01T10:12:11.387Z",
  "updateTime": "2024-08-01T10:12:11.387Z",
  "data": {},
  "record": {
    "tableId": "string",
    "recordId": "string",
    "versionId": "string",
    "createTime": "2024-08-01T10:12:11.387Z",
    "updateTime": "2024-08-01T10:12:11.387Z",
    "data": {}
  }
}

Updated response with this change:

{
  "record": {
    "tableId": "string",
    "recordId": "string",
    "versionId": "string",
    "createTime": "2024-08-01T10:12:11.387Z",
    "updateTime": "2024-08-01T10:12:11.387Z",
    "data": {}
  }
}

2024-08-05: Updated get record response body

Additive change

This is the first of two planned changes to make the get record response format consistent with the response format for other record endpoints, in which all response parameters are included inside of a record object.

The first change is additive to allow time for users to migrate to the new format, which will be enforced with the second change.

Original response:

{  
  "tableId": "string",  
  "recordId": "string",  
  "versionId": "string",  
  "createTime": "2024-06-17T15:21:37.532Z",  
  "updateTime": "2024-06-17T15:21:37.532Z",  
  "data": {}  
}

Updated response with this change:

{
  "tableId": "string",
  "recordId": "string",
  "versionId": "string",
  "createTime": "2024-08-01T10:12:11.387Z",
  "updateTime": "2024-08-01T10:12:11.387Z",
  "data": {},
  "record": {
    "tableId": "string",
    "recordId": "string",
    "versionId": "string",
    "createTime": "2024-08-01T10:12:11.387Z",
    "updateTime": "2024-08-01T10:12:11.387Z",
    "data": {}
  }
}

Expected response with second change:

{
  "record": {
    "tableId": "string",
    "recordId": "string",
    "versionId": "string",
    "createTime": "2024-08-01T10:12:11.387Z",
    "updateTime": "2024-08-01T10:12:11.387Z",
    "data": {}
  }
}