如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时，可通过自定义API来实现 如果您的业务设置为聚合关系，则只能在主要方自定义API。 图1 查看操作类型 添加自定义API 在业务设计页面，选中某个业务对象。 单击BO属性操作中的“自定义API”，进入编辑自定义API页面。

查看更多 →

附录：API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上，定义了特有的API定义项，即扩展定义，如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1：x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义ROMA

查看更多 →

导出自定义后端API 功能介绍 导出自定义后端API，导出文件内容符合swagger标准规范。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/{p

查看更多 →

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。对于获取用户Token接口，如果调用后返回状态码为201，则表示请求成功。对应请求消息头，响应同样也有消息头，如Content-type。对于获取用户Token接口，返回如图1所示的

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求

查看更多 →

0的客户端鉴权模式获取用户access_token接口，如果调用后返回状态码为“200”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于使用OAuth 2.0的client credentials鉴权模式获取用户Token接口，返回如图1所示的消息头。

查看更多 →

对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Co

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于NLP服务接口，如果调用后返回状态码为“200”，则表示请求成功。 响应消息头 对应请求消息头，

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，表示了请求响应的状态，完整的状态码列表请参见状态码。 对于CBS服务接口，如果调用后返回状态码为“200”，则表示请求成功。 响应消息头 对应请求消息头，响应同

查看更多 →

对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体（可选） 响应消息体通常以结构化格式返回，与响应消息头中

查看更多 →

返回结果 座席未登录的情况下，输出结果如下： ----login ok ----resetSkill ok ----getAgentEvent ok:{"message":"","retcode":"0","event":{"content":null,"eventType":"

查看更多 →

对于管理员创建IAM用户接口，返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于SIS服务接口，如果调用后返回状态码为“200”，则表示请求成功。 响应消息头 对应请求消息头，

查看更多 →

。 对于管理员创建IAM用户接口，返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

查看更多 →

返回结果 状态码 请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对

查看更多 →

ntent-type”。 对于批量文件处理接口，返回如图1所示的消息头。 图1 响应消息头 响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于批量文件处理接口，返回的消息体中部分内容如下所示。 { "data":

查看更多 →

t-type”。 对于获取访问凭据接口，不返回响应消息头。 响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取访问凭据接口，返回如下消息体。 { "access_token"

查看更多 →

对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Co

查看更多 →

对于获取用户Token的接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Co

查看更多 →