---
schema_version: "1"
id: 0151cc3ff803dc30bb7c193ce53dc21d0a97f2533cf3e89d0eefc6ba75f16135
title: "Interface: DataApi"
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/salesforce-functions/functions/guide/nodesdk/interfaces/dataapi.md
canonical_url: https://developer.salesforce.com/docs/platform/functions/guide/dataapi.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9f7a2ea80b310c0bf271f1bb4906b6ae71fd7cb2fbc64f4ab58cdd7b067c8f33
products:
  - Salesforce Functions
---
[sf-fx-runtime-nodejs](https://developer.salesforce.com/docs/platform/functions/NODE_README.md) / DataApi

# Interface: DataApi

Data API client to interact with data in a Salesforce org.

## Properties

### accessToken

The access token used by this API client. Can be used to initialize a third-party API client or to perform custom API calls with a HTTP library.

• `Readonly` **accessToken**: _string_


## Methods

### commitUnitOfWork

▸ **commitUnitOfWork**(`unitOfWork`: [_UnitOfWork_](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md)): _Promise_<Map<string, [_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>\>

Commits a [UnitOfWork](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md), executing all operations registered with it. If any of these operations fail, the whole unit is rolled back. To examine results for a single operation, inspect the returned map (which is keyed with [ReferenceId](https://developer.salesforce.com/docs/platform/functions/modules.md#referenceid) returned from [UnitOfWork.registerCreate](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md#registercreate) and [UnitOfWork.registerUpdate](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md#registerupdate).

#### Parameters

| Name         | Type                          | Description                                |
| :----------- | :---------------------------- | :----------------------------------------- |
| `unitOfWork` | [_UnitOfWork_](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md) | The [UnitOfWork](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md) to commit. |

**Returns:** _Promise_<Map<string, [_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>\>

A map of [RecordModificationResult](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)s, indexed by their [ReferenceId](https://developer.salesforce.com/docs/platform/functions/modules.md#referenceid)s.


---

### create

▸ **create**(`record`: [_RecordForCreate_](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforcreate)): _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

Creates a new record described by the given [RecordForCreate](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforcreate).

#### Parameters

| Name     | Type                                               | Description                    |
| :------- | :------------------------------------------------- | :----------------------------- |
| `record` | [_RecordForCreate_](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforcreate) | The record create description. |

**Returns:** _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

A [RecordModificationResult](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md) that contains the created data wrapped in a Promise.


---

### delete

▸ **delete**(`type`: _string_, `id`: _string_): _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

Deletes a record, based on the given type and id.

#### Parameters

| Name   | Type     | Description                              |
| :----- | :------- | :--------------------------------------- |
| `type` | _string_ | The object type of the record to delete. |
| `id`   | _string_ | The id of the record to delete.          |

**Returns:** _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

A [RecordModificationResult](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md) that contains the deleted data wrapped in a Promise.


---

### newUnitOfWork

▸ **newUnitOfWork**(): [_UnitOfWork_](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md)

Creates a new and empty [UnitOfWork](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md).

**Returns:** [_UnitOfWork_](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md)

An empty [UnitOfWork](https://developer.salesforce.com/docs/platform/functions/guide/unitofwork.md).


---

### query

▸ **query**(`soql`: _string_): _Promise_<[_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md)\>

Queries for records with a given SOQL string.

#### Parameters

| Name   | Type     | Description      |
| :----- | :------- | :--------------- |
| `soql` | _string_ | The SOQL string. |

**Returns:** _Promise_<[_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md)\>

A [RecordQueryResult](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md) that contains the queried data wrapped in a Promise.


---

### queryMore

▸ **queryMore**(`recordQueryResult`: [_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md)): _Promise_<[_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md)\>

Queries for more records, based on the given [RecordQueryResult](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md).

#### Parameters

| Name                | Type                                        | Description                              |
| :------------------ | :------------------------------------------ | :--------------------------------------- |
| `recordQueryResult` | [_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md) | The query result to query more data for. |

**Returns:** _Promise_<[_RecordQueryResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md)\>

A [RecordQueryResult](https://developer.salesforce.com/docs/platform/functions/guide/recordqueryresult.md) that contains the queried data wrapped in a Promise.


---

### update

▸ **update**(`update`: [_RecordForUpdate_](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforupdate)): _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

Updates an existing record described by the given [RecordForUpdate](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforupdate).

#### Parameters

| Name     | Type                                               | Description                    |
| :------- | :------------------------------------------------- | :----------------------------- |
| `update` | [_RecordForUpdate_](https://developer.salesforce.com/docs/platform/functions/modules.md#recordforupdate) | The record update description. |

**Returns:** _Promise_<[_RecordModificationResult_](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md)\>

A [RecordModificationResult](https://developer.salesforce.com/docs/platform/functions/guide/recordmodificationresult.md) that contains the updated data wrapped in a Promise.