Links¶

addLink

Add one linked record to a link-column cell without replacing its existing links.

Note: This was added in SDK version 1.0-latest.

sdk.addLink({ tableName, rowId, linkColumnName, otherRowId });

Parameters

tableName

string — name of the table containing the link column

rowId

string — the _id of the source row in tableName

linkColumnName

string — name of the link column; use its display name, not its internal key

otherRowId

string — the _id of the record to add from the link column's configured target table

Returns .data holds { success: true, row } — row is the updated source row.

Example

const res = await sdk.addLink({
  tableName: "Tasks",
  rowId: "fcHIocncTsOygA3FjL-toQ",
  linkColumnName: "Related projects",
  otherRowId: "NSPa_fd4SEqRESqOZzRqyg",
});
const updatedRow = res.data.row;

deleteLink

Delete one linked record from a link-column cell without changing its other links.

Note: This was added in SDK version 1.0-latest.

sdk.deleteLink({ tableName, rowId, linkColumnName, otherRowId });

Parameters

tableName

string — name of the table containing the link column

rowId

string — the _id of the source row in tableName

linkColumnName

string — name of the link column; use its display name, not its internal key

otherRowId

string — the _id of the record to remove from the link column's configured target table

Returns .data holds { success: true, row } — row is the updated source row.

Example

const res = await sdk.deleteLink({
  tableName: "Tasks",
  rowId: "fcHIocncTsOygA3FjL-toQ",
  linkColumnName: "Related projects",
  otherRowId: "NSPa_fd4SEqRESqOZzRqyg",
});
const updatedRow = res.data.row;

batchAddLinks

Add links to one or more rows in the same source table.

Note: This was added in SDK version 1.0-latest.

sdk.batchAddLinks({ tableName, linksData });

Parameters

tableName

string — name of the table containing the link columns

linksData

array — row-oriented link changes. Each item has a row_id source-row ID and a links object. Each links key is a link column display name and its value is an array of linked row IDs.

Returns .data holds { success: true, rows } — rows is the array of updated source rows.

Example

const res = await sdk.batchAddLinks({
  tableName: "Tasks",
  linksData: [
    {
      row_id: "fcHIocncTsOygA3FjL-toQ",
      links: {
        "Related projects": ["NSPa_fd4SEqRESqOZzRqyg", "eA6rQDuxQyGITmD1hrfyzw"],
        Reviewers: ["bBDbhbzXReSPWpcxq225xA", "NSPa_fd4SEqRESqOZzRqyg"],
      },
    },
    {
      row_id: "BIXJ_dUMS1OW8Lyoxrx4Fw",
      links: {
        "Related projects": ["eA6rQDuxQyGITmD1hrfyzw", "QgK2KMf8Sxad8duPcq6gQA"],
      },
    },
  ],
});
const updatedRows = res.data.rows;

batchDeleteLinks

Delete specified links from one or more rows in the same source table. Links not listed in linksData remain unchanged.

Note: This was added in SDK version 1.0-latest.

sdk.batchDeleteLinks({ tableName, linksData });

Parameters

tableName

string — name of the table containing the link columns

linksData

array — row-oriented link changes. Each item has a row_id source-row ID and a links object. Each links key is a link column display name and its value is an array of linked row IDs to remove.

Returns .data holds { success: true, rows } — rows is the array of updated source rows.

Example

const res = await sdk.batchDeleteLinks({
  tableName: "Tasks",
  linksData: [
    {
      row_id: "fcHIocncTsOygA3FjL-toQ",
      links: {
        "Related projects": ["NSPa_fd4SEqRESqOZzRqyg", "eA6rQDuxQyGITmD1hrfyzw"],
      },
    },
    {
      row_id: "BIXJ_dUMS1OW8Lyoxrx4Fw",
      links: {
        "Related projects": ["eA6rQDuxQyGITmD1hrfyzw"],
      },
    },
  ],
});
const updatedRows = res.data.rows;