本协议约定在低代码平台编写微函数时调用DataApi进行数据交互的相关规范，包括数据的增、删、改、查等相关函数规范。

​

属性

每个微函数中会把 DataApi 实例传入到 context.org.dataApi 参数中，每个实例都有以下属性：

• accessToken: string 当前API实例需要使用的 access token，在初始化第三方API实例或发起一个自定义API请求时可能需要该属性值进行身份验证。

​

方法

每个 DataApi 实例都可以调用以下函数来实现数据交互。

​

commitUnitOfWork

▸ commitUnitOfWork(unitOfWork: UnitOfWork): Promise<Map<string, RecordModificationResult>>

提交一个 UnitOfWork ，执行所有注册到它的操作。如果这些操作中的任何一个失败，整个单元就会回滚。要检查单个操作的结果，请检查返回的映射(使用从 UnitOfWork.registerCreate 和 UnitOfWork.registerUpdate 返回的 ReferenceId 作为键值)。

参数列表：

返回值：Promise<Map<string, RecordModificationResult>>

返回一个 RecordModificationResult>> 的集合，由它们的 ReferenceIds 索引。

​

create

▸ create(record: RecordForCreate): Promise<RecordModificationResult>

按传入的记录信息创建一条新记录。

参数列表：

返回值：Promise<RecordModificationResult>

返回一个包括创建好的记录信息的 Promise。

​

delete

▸ delete(type: string, _id: string): Promise<RecordModificationResult>

按传入的对象Api名称及记录id值删除一条记录。

参数列表：

返回值：Promise<RecordModificationResult>

返回一个包括被删除记录信息的 Promise。

​

newUnitOfWork

▸ newUnitOfWork(): UnitOfWork

创建一个新的空 UnitOfWork。

返回值: UnitOfWork

返回一个空的 UnitOfWork。

​

query

▸ query(soql: string): Promise<RecordQueryResult>

根据传入的 SOQL 参数值，查询对象记录.

参数列表：

返回值: Promise<RecordQueryResult>

返回一个包括请求到的对象记录集合的 Promise。

​

queryMore

▸ queryMore(recordQueryResult: RecordQueryResult): Promise<RecordQueryResult>

在之前查询到的对象记录集合，即 RecordQueryResult 基础上进一步查询更多对象记录。

参数列表：

返回值: Promise<RecordQueryResult>

返回一个包括请求到的对象记录集合的 Promise。

​

update

▸ update(update: RecordForUpdate): Promise<RecordModificationResult>

按传入的记录信息修改一条存在的记录。

参数列表：

返回值: Promise<RecordModificationResult>

返回一个包括修改后的记录信息的 Promise。

​

结构类

以下是上述微函数方法中需要用到的参数和返回值规范。

​

RecordForCreate

Ƭ RecordForCreate: object

调用 create 或 在 UnitOfWork 中注册一个创建新记录的操作时需要传入的记录信息。

比如：

{
    type: "Account",
    fields: {
      Name: `${name}-${Date.now()}`,
      AccountNumber: accountNumber,
      Industry: industry,
      Type: type,
      Website: website,
    },
  };

​

RecordForUpdate

Ƭ RecordForUpdate: object

调用 update 或 在 UnitOfWork 中注册一个修改记录的操作时需要传入的记录信息。

比如：

{
    type: "Account",
    fields: {
      _id: id,
      Name: `${name}-${Date.now()}`,
      AccountNumber: accountNumber,
      Industry: industry,
      Type: type,
      Website: website,
    },
  };

​

RecordModificationResult

描述对象记录增、删、改相关操作的返回结果。

​

RecordQueryResult

描述对象记录查询返回结果，主要属性及其描述如下所示。

​

done

数据查询操作是否已经完结: boolean。

如果为真，则不能再从查询结果中检索其他记录。如果为false，则仍然需要继续检索一个或多个记录。

​

nextRecordsUrl

下一组记录的URL(如果有的话): string。

​

records

查询结果中的记录： Record[]。

​

totalSize

查询返回的记录总数： number。

​

Record

Ƭ Record: object

从 query or queryMore 请求中获取到的记录集合。

​

ReferenceId

Ƭ ReferenceId: string

引用将在将来创建、删除或修改的记录。

​

示例

"use strict";

export default async function (event, context, logger) {
  logger.info(
    `Invoking salesforcesdkjs Function with payload ${JSON.stringify(
      event.data || {}
    )}`
  );

  // Extract Properties from Payload
  const { name, accountNumber, industry, type, website } = event.data;

  // Validate the payload params
  if (!name) {
    throw new Error(`Please provide account name`);
  }

  // Define a record using the RecordForCreate type and providing the Developer Name
  const account = {
    type: "Account",
    fields: {
      Name: `${name}-${Date.now()}`,
      AccountNumber: accountNumber,
      Industry: industry,
      Type: type,
      Website: website,
    },
  };

  try {
    // Insert the record using the SalesforceSDK DataApi and get the new Record Id from the result
    const { _id: recordId } = await context.org.dataApi.create(account);

    // Query Accounts using the SalesforceSDK DataApi to verify that our new Account was created.
    const soql = `SELECT Fields(STANDARD) FROM Account WHERE Id = '${recordId}'`;
    const queryResults = await context.org.dataApi.query(soql);
    return queryResults;
  } catch (err) {
    // Catch any DML errors and pass the throw an error with the message
    const errorMessage = `Failed to insert record. Root Cause: ${err.message}`;
    logger.error(errorMessage);
    throw new Error(errorMessage);
  }
}

​

参考资料

• Saleforce DataApi