华为云用户手册

开启调试 在开发过程中可以启用调试模式，借助控制台日志实时查看上报日志的记录情况，观察具体结果并根据需要进行调整。 在初始化LTSSDK之前，调用类方法+(void)setLogLevel:(LTSLoggerLevel)logLevel设置调试级别：Debug、Info、Warn、Error、Off。 Objective-C语言示例代码： #ifdef DEBUG [LTSSDK setLogLevel:LTSLoggerLevelDebug]; #endif

版本更新说明 SDK如何处理个人信息请参考华为 云日志 服务移动端日志采集SDK隐私声明。 您集成和使用我们的SDK时需要遵从个人信息保护基本要求，详情请参考华为云日志服务移动端日志采集SDK开发者合规指南。 表1 版本更新说明 版本号 下载地址 检验信息下载地址 更新说明 系统 1.0.24 单击下载 单击下载 支持更多region：华东-上海一、华南-广州。 优化内存使用、日志发送等。 iOS10、Xcode11及以上 1.0.21 单击下载 单击下载 优化初始化函数initWithConfig。 为配置函数config添加废弃声明。 iOS10、Xcode11及以上 1.0.19 单击下载 单击下载 调整配置项阈值。 修复兼容性问题。 iOS10、Xcode11及以上 1.0.18 单击下载 单击下载 增加设置调试日志级别接口：setLogLevel。 在控制台输出配置项、上报接口参数、请求发送内容。 上报接口参数labels支持嵌套。 请求发送控制、数据库大小限制等优化。 iOS10、Xcode11及以上 1.0.15 单击下载 单击下载 首次发布，提供四个接口：初始化 initWithConfig、配置 config、上报日志 report、立即上报日志 reportImmediately。 iOS10、Xcode11及以上。

步骤1：创建业务操作 准备工作。 在应用运行态中获取创建业务操作的API信息，具体操作请参见查询API。 根据实际业务对象的生命周期管理流程，调用API创建业务操作。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/basic/api/LifecycleBusinessOperation/create { "params": { "name": "发布", "nameEn": "Publish", "description": "", "descriptionEn": "" } } 其中，{Endpoint}、{appID}表示数据建模引擎所在域名/IP地址和应用ID，“name”、“nameEn”、“description”、“descriptionEn”表示业务操作的中英文名称和中英文描述。 响应示例 { "result": "SUC CES S", "data": [ { "id": "504753788985286656", "creator": "XDM_Developer 93172bbfd0f644************345386", "modifier": "XDM_Developer 93172bbfd0f644************345386", "createTime": "2023-05-29T12:31:21.166+0000", "lastUpdateTime": "2023-05-29T12:31:21.166+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "LifecycleBusinessOperation", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2023-05-29T11:27:42.000+0000", "lastUpdateTime": "2023-05-29T11:27:42.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "LifecycleBusinessOperation", "businessCode": "LOP00000001", "description": "", "descriptionEn": "", "nameEn": "Publish", "name": "发布", "disableFlag": false } ], "errors": [] }

步骤2：创建状态 准备工作。 在应用运行态中获取创建状态的API信息，具体操作请参见查询API。 根据实际业务对象的生命周期管理流程，调用API创建状态。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/basic/api/LifecycleState/create { "params": { "name": "已发布", "nameEn": "Published", "description": "", "descriptionEn": "", "internalName": "Published" } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“name”、“nameEn”、“description”、“descriptionEn”表示生命周期状态的中英文名称和中英文描述。 响应示例 { "result": "SUCCESS", "data": [ { "id": "504966116662059008", "creator": "XDM_Developer 93172bbfd0f644************345386", "modifier": "XDM_Developer 93172bbfd0f644************345386", "createTime": "2023-05-30T02:35:04.029+0000", "lastUpdateTime": "2023-05-30T02:35:04.029+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "LifecycleState", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2023-05-29T11:27:42.000+0000", "lastUpdateTime": "2023-05-29T11:27:42.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "LifecycleState", "descriptionEn": "", "businessCode": "L CS 00000003", "name": "已发布", "description": "", "nameEn": "Published", "internalName": "Published", "disableFlag": false, "extAttrs": [], "extAttrMap": {} } ], "errors": [] }

步骤4：绑定生命周期模板 准备工作。 在应用运行态中获取绑定生命周期模板的API信息，具体操作请参见。 根据实际业务对象的生命周期管理，调用API绑定生命周期模板。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/basic/api/LifecycleTemplate/updateLifecycleInfo { "params": { "applicationId": "1bab18b61c6f4f5bbd031d2d8e0e3fda", "id": "478135618698743808", "curLifecycleTemplateAttached": [ { "id": "63c7e2aad21a4715bd8ac08d73da4805", "templateAttrName": "生命周期模板", "templateAttrNameEn": "LifecycleTemplate", "templateAttrDescription": "生命周期模板", "templateAttrDescriptionEn": "LifecycleTemplate", "stateAttrName": "生命周期状态", "stateAttrNameEn": "LifecycleState", "stateAttrDescription": "生命周期状态", "stateAttrDescriptionEn": "LifecycleState", "attachTemplateId": "504971863990996992", "attachTemplateName": "Product Release Process", "attachTemplateNameEn": "产品发布流程" } ] } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“attachTemplateId”、“attachTemplateName”、“attachTemplateNameEn”表示需要绑定的生命周期模板ID、名称和英文名称。 响应示例 { "result": "SUCCESS", "data": [ { "id": "478135618698743808", "rdmExtensionType": "TypeDefinition", "className": "TypeDefinition", ...... // 实体详细信息 "lifecycleTemplateAttached": [ { "attachTemplateId": "477901037156446208", "stateAttrDescriptionEn": "LifecycleState", "readOnly": true, "stateAttrName": "生命周期状态", "attachTemplateNameEn": "Test0316", "templateAttrDescriptionEn": "LifecycleTemplate", "templateAttrDescription": "生命周期模板", "stateAttrDescription": "生命周期状态", "id": "63c7e2aad21a4715bd8ac08d73da4805", "attachTemplateName": "Test0316", "templateAttrNameEn": "LifecycleTemplate", "templateAttrName": "生命周期模板", "stateAttrNameEn": "LifecycleState" } ], "curLifecycleTemplateAttached": [ { "id": "63c7e2aad21a4715bd8ac08d73da4805", "templateAttrName": "生命周期模板", "templateAttrNameEn": "LifecycleTemplate", "templateAttrDescription": "生命周期模板", "templateAttrDescriptionEn": "LifecycleTemplate", "stateAttrName": "生命周期状态", "stateAttrNameEn": "LifecycleState", "stateAttrDescription": "生命周期状态", "stateAttrDescriptionEn": "LifecycleState", "attachTemplateId": "504971863990996992", "attachTemplateName": "Product Release Process", "attachTemplateNameEn": "产品发布流程" } ] } ], "errors": [] }

步骤5：使用生命周期模板 准备工作。 在应用运行态中获取更新生命周期阶段的API信息，具体操作请参见查询API。 根据实际业务对象当前的生命周期阶段，调用API更新生命周期。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/update { "params": { ...... // 其他实体属性 "lifecycleTemplate": { "id": "455805277254459392", "clazz": "LifecycleTemplate" }, "lifecycleState": { "id": "455663911463555072", "clazz": "LifecycleState" }, "tenant": { "id": "-1", "clazz": "Tenant" }, "creator": "XDM_Developer 93172bbfd0f644************345386", "modifier": "XDM_Developer", "id": "505046194565681152" } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，{entityName}表示实体的英文名称，“lifecycleTemplate”、“lifecycleState”表示实例需要更新的生命周期模板和状态。 响应示例 { "result": "SUCCESS", "data": [ { "id": "505046194565681152", ...... // 其他实例属性 "disableFlag": false, "lifecycleTemplate": { "id": "455805277254459392", "className": "lifecycleTemplate" ...... // 其他生命周期模板属性 }, "lifecycleState": { "id": "455801165657935872", "className": "LifecycleState" ...... // 其他状态属性 } } ], "errors": [] }

涉及的接口 表1 涉及的接口 接口名称 说明 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/LifecycleBusinessOperation/create 创建业务操作。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/LifecycleState/create 创建状态。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/LifecycleTemplate/create 创建生命周期模板。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/LifecycleTemplate/updateLifecycleInfo 为实体绑定生命周期模板。 https://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/update 修改 数据实例 ，更新数据实例当前的生命周期阶段。 https://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/checkout 检出M-V模型的数据实例，更新数据实例当前的生命周期阶段。 https://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/checkin 检入M-V模型的数据实例，更新数据实例当前的生命周期阶段。

步骤3：创建生命周期模板 准备工作。 在应用运行态中获取创建生命周期模板的API信息，具体操作请参见查询API。 根据实际业务对象的生命周期管理流程，调用API创建生命周期模板。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/basic/api/LifecycleTemplate/create { "params": { "name": "产品发布流程", "nameEn": "Product Release Process", "description": "", "descriptionEn": "", "master": { "id": null, "category": "", "name": "产品发布流程", "nameEn": "Product Release Process" }, "branch": { "id": null } } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“master”、“branch”表示生命周期模板的主对象和分支对象。 响应示例 { "result": "SUCCESS", "data": [ { "id": "504971863990996992", "className": "LifecycleTemplate", "name": "产品发布流程", "description": "", "master": { "id": "504971863999385600", "className": "LifecycleTemplateMaster", "businessCode": "LCT00000002", "nameEn": "Product Release Process", "name": "产品发布流程", "disableFlag": false }, "branch": { "id": "504971863999385601", "className": "LifecycleTemplateBranch", "version": "A" }, "latest": true, "latestIteration": true, "versionCode": 1, "iteration": 1, "version": "A", "latestVersion": true, "workingCopy": false, "workingState": { "code": "CHECKED_IN", "cnName": "已检入", "enName": "checked in", "alias": "CHECKED_IN" }, "checkOutUserName": null, "checkOutTime": null, "preVersionId": null, "descriptionEn": "", "nameEn": "Product Release Process", "reserved": null, "lifecyclePhaseList": [] } ], "errors": [] }

全量数据服务概述 为提升应用开发人员的开发效率，工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）提供对应用全量数据服务的管理功能，支持查看所有可调用API的信息，支持调用应用部署后的所有API。全量数据服务API包括系统管理API、数据模型生成API、定制API的基本信息、参数信息和示例。 应用开发人员可以在应用运行态的全量数据服务快速获取应用下所有类型API的清单、查看API详情、导出API文档，提升模型的消费速度和API调用速度，快速使能工业应用。 父主题： 使用全量数据服务API

概述 在以往的工业应用开发场景中，常见的难题包括跨数据类型、跨数据库搜索难度大，业务数据种类多、搜索场景多、第三方搜索引擎在线应用无法在客户私有环境使用、图形搜索实现难度大等。为了满足应用开发人员研发效率的需求，工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）提供根据关键字查询特定目标并分页返回所有满足匹配要求的对象条目、按对象属性设置搜索条件并通过逻辑关系组合复杂搜索条件进行对象搜索的搜索服务管理功能。

步骤4：调用服务编排生成的API 准备工作。 在应用运行态中获取创建业务操作的API信息，具体操作请参见查询API。 根据实际业务对象的生命周期管理流程，调用API创建业务操作。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/publicservices/rdm/basic/api/customservice/QueryByPriceRemain/execute/{pageSize}/{curPage} { "params": { "price": "19.9", "remain": "9", "returnTotalCountFlag": "true" } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“price”、“remain”表示对应服务编排的自定义入参。 响应示例 { "result": "SUCCESS", "data": [ { "cinema": "太平洋影城", "film": "萌鸡小队：萌闯新世界", "price": "9.90", "remain": 17 }, { "cinema": "保利国际影城", "film": "满江红", "price": "19.90", "remain": 9 } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 20, "totalRows": 2, "totalPages": 1 } }

步骤1：创建服务编排 准备工作。 在应用运行态中获取创建服务编排的API信息，具体操作请参见查询API。 根据实际的业务需求，调用API创建服务编排。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/create { "params": { "name": "按票价和余额查询", "nameEn": "QueryByPriceRemain", "description": "按票价和余额查询", "descriptionEn": "Query by price and remain", "owner": "", "needPublishToApiCenter": false, "tags": [], "supportPagination": true, "master": { "supportPagination": true, "apiType": "javascript", "tenantNameEn": "TestDME", "applicationId": "{applicationId}", // 应用ID "tenantAppId": "0", "tagIds": [] }, "gray": false // 此参数已废弃 } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“name”、“nameEn”、“description”、“descriptionEn”表示服务编排的中英文名称和中英文描述，“master”表示服务编排所属的应用信息。 响应示例 { "result": "SUCCESS", "data": [ { "id": "505105143826485248", "creator": "XDM_Developer 93172bbfd0f644************345386", "modifier": "XDM_Developer 93172bbfd0f644************345386", "createTime": "2023-05-30T11:47:30.688+0000", "lastUpdateTime": "2023-05-30T11:47:30.688+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "CustomService", "tenant": { "id": "-1", "rdmExtensionType": "Tenant", ...... }, "className": "CustomService", "name": "按票价和余额查询", "state": "INWORK", "nameEn": "QueryByPriceRemain", "descriptionEn": "Query by price and remain", "description": "按票价和余额查询", "owner": "", "disabled": null, "needPublishToApiCenter": false, "publishedToApiCenter": false, "publishedToApiCenterTime": null, "needAccessControlled": false, "latest": true, "workingCopy": true, "version": "A", "iteration": 1, "master": { "id": "505105143805513728", "creator": "XDM_Developer 93172bbfd0f644************345386", "modifier": "XDM_Developer 93172bbfd0f644************345386", "createTime": "2023-05-30T11:47:30.683+0000", "lastUpdateTime": "2023-05-30T11:47:30.683+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "CustomServiceMaster", "tenant": { "id": "-1", "rdmExtensionType": "Tenant" ...... }, "className": "CustomServiceMaster", "apiType": "javascript", "apiNumber": "CS00000010", "tenantNameEn": "TestDME", "tenantAppId": "0", "tagList": [] }, "apiCenterInfo": { ...... }, "gray": false, // 此参数已废弃 "supportPagination": true } ], "errors": [] }

涉及的接口 表1 涉及的接口 接口名称 说明 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/create 创建服务编排。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/code/save 保存服务编排。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/publish 发布服务编排。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/{APIName}/execute 调用服务编排脚本。

步骤3：发布服务编排 准备工作。 在应用运行态中获取发布服务编排的API信息，具体操作请参见查询API。 完成服务编排脚本编写后，调用API发布服务编排。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/customservice/publish?versionId=505105143826485248 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“versionId”表示待发布服务编排的版本ID。 响应示例 { "result": "SUCCESS", "data": [], "errors": [] }

请求参数 表2 请求body参数 参数 是否必填 参数类型 描述 sourceInstanceId 是 Int version.唯一编码。 sourceMasterId 是 String master.唯一编码。 传入参数时，必填参数需至少传入一个，即至少传入sourceInstanceId参数或sourceMasterId参数。为篇幅起见，这里只展示部分内容。更多参数信息，您可以在全量数据服务进行查看。

响应示例 为篇幅起见，这里只展示部分内容。 { "result": "SUCCESS", "data": [ { "id": "515167665271083008", "creator": "TestAccount2 5547b9adee54423cb**********", "modifier": "TestAccount2 5547b9adee54423cb**********", "createTime": "2023-06-27T05:57:56.000+0000", "lastUpdateTime": "2023-06-27T06:12:22.752+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "TestMV", "tenant": { ...... }, "className": "TestMV", "master": { "id": "515167665275277312", "tenant": { ...... }, "className": "TestMVMaster" }, "branch": { "id": "515167665313026048", "creator": "TestAccount2 5547b9adee54423cb**********", "modifier": "TestAccount2 5547b9adee54423cb**********", "createTime": "2023-06-27T06:12:22.774+0000", "lastUpdateTime": "2023-06-27T06:12:22.774+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "TestMVBranch", "tenant": { ...... }, "className": "TestMVBranch", "version": "A" }, "latest": true, "versionCode": 1, "iteration": 1, "version": "A", "workingState": { "code": "CHECKED_IN", "cnName": "已检入", "enName": "checked in", "alias": "CHECKED_IN" }, "checkOutUserName": null, "checkOutTime": null, "preVersionId": null } ], "errors": [] }

请求示例 示例背景 假设，您已在cn-north-4区域的TestApp应用中，构建一个名称为“TestMV”的M-V模型数据实体，并完成了实体发布、应用发布和应用部署。希望可以根据指定的版本对象唯一编码（481785585908850688）或主对象唯一编码（481785532712488960），创建一个新的数据实例。 示例代码 为篇幅起见，这里只展示必填参数。 { "params":{ ...... "sourceInstanceId":"481785585908850688", "sourceMasterId":"481785532712488960" } }

URI URL格式： POST http://{Endpoint}/rdm_{appID}_app/publicservices/api/{entityName}/saveAs 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。

步骤4：发布和验证搜索服务 准备工作。 在应用运行态中获取发布搜索服务的API信息，具体操作请参见查询API。 完成搜索服务的配置后，调用API发布搜索服务。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/publishSingle { "params": "505115507221864448" } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“params”表示待发布的搜索服务ID。 响应示例 { "result": "SUCCESS", "data": [], "errors": [] }

步骤5：同步搜索服务数据 准备工作。 在应用运行态中获取同步搜索服务的API信息，具体操作请参见查询API。 根据实际业务需求，调用API同步搜索服务数据。 请求示例 PUT http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServ/startEsSync/{serNumber} 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“serNumber”待同步的搜索服务ID。 响应示例 { "result": "SUCCESS", "data": [], "errors": [] }

步骤1：定义搜索服务 准备工作。 在应用运行态中获取定义搜索服务的API信息，具体操作请参见查询API。 根据实际业务需求，调用API创建搜索服务。 请求示例 POST https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/create { "params": { "createDTO": { "name": "搜索服务示例", "description": "搜索服务示例", "descriptionEn": "Sample", "nameEn": "Sample", "owner": "", "tenantAliasName": "TestDME" }, "tags": [] } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“name”、“nameEn”、“description”、“descriptionEn”表示搜索服务的中英文名称和中英文描述。 响应示例 { "result": "SUCCESS", "data": [ { "id": "505115507221864448", "className": "XDMSearchServDefine", "name": "搜索服务示例", "description": "搜索服务示例", "kiaguid": null, "securityLevel": "internal", "master": { "id": "505115507255418880", "creator": "TestAccount2 5547b9adee************8aac057d2c", "modifier": "TestAccount2 5547b9adee************8aac057d2c", "createTime": "2023-05-30T12:28:41.522+0000", "lastUpdateTime": "2023-05-30T12:28:41.522+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "XDMSearchServDefineMaster", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-12-01T11:24:39.000+0000", "lastUpdateTime": "2022-12-01T11:24:39.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "XDMSearchServDefineMaster", "servNumber": "SS60466196" }, "branch": { "id": "505115507255418881", "creator": "TestAccount2 5547b9adee************8aac057d2c", "modifier": "TestAccount2 5547b9adee************8aac057d2c", "createTime": "2023-05-30T12:28:41.569+0000", "lastUpdateTime": "2023-05-30T12:28:41.569+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "XDMSearchServDefineBranch", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-12-01T11:24:39.000+0000", "lastUpdateTime": "2022-12-01T11:24:39.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "XDMSearchServDefineBranch", "version": "A" }, "latest": true, "latestIteration": true, "versionCode": 1, "iteration": 1, "version": "A", "latestVersion": true, "workingCopy": true, "workingState": { "code": "INWORK", "cnName": "工作中", "enName": "inwork", "alias": "INWORK" }, "checkOutUserName": "TestAccount2 5547b9adee54423cbc05978aac057d2c", "checkOutTime": "2023-05-30T12:28:41.514+0000", "preVersionId": null, "owner": "", "descriptionEn": "Sample", "esindexId": null, "dmentityVersion": null, "dmentityVersionName": null, "step": null, "nameEn": "Sample", "needRefresh": false, "graphId": null, "lifecycleTemplate": null, "lifecycleState": null, "disableFlag": false } ], "errors": [] }

步骤3：添加服务配置 准备工作。 在应用运行态中获取添加服务配置的API信息，具体操作请参见查询API。 根据实际业务需求，调用API添加服务配置。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServColumnController/saveDataServIndexEntityList { "params": { "searchServId": "505115507221864448", "searchServIndexEntityVOList": [ { "entityName": "TestData", "entityNameEn": "TestData", "dataServRelationVOList": [ { "attrName": "Code", "attrDesc": null, "searchIndexId": "505115594543079424", "indexType": "TEXT", "dataModelVersionNameEn": "Tenant", "extendAttr": false, "attrType": "STRING", "sortNo": 1 } ] } ] } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“searchServIndexEntityVOList”表示服务配置中选中的实体和属性。 响应示例 { "result": "SUCCESS", "data": [], "errors": [] }

涉及的接口 表1 涉及的接口 接口名称 说明 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/create 创建搜索服务。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServiceIndexDefinition/saveList 添加索引。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServColumnController/saveDataServIndexEntityList 添加服务配置。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchservicedefine/publishSingle 发布搜索服务。 https://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServ/startEsSync/{serNumber} 同步搜索服务。

步骤2：添加索引 准备工作。 在应用运行态中获取添加索引的API信息，具体操作请参见查询API。 根据实际业务需求，调用API添加索引。 请求示例 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/searchServiceIndexDefinition/saveList { "params": { "searchServId": "505115507221864448", "searchServName": "搜索服务示例", "indexServColuVOList": [ { "id": null, "indexName": "SampleIndex", "indexDesc": "", "indexType": "TEXT", "operator": null, "inputSeparator": null, "segMethod": "NOWORD", "segOption": "NOTINVOLVED", "searchUsage": true, "keywordUsage": true, "displayUsage": true, "matchType": "FUZZY", "key": "indexDefinition43" } ] } } 其中，{Endpoint}表示数据建模引擎所在域名或IP地址，{appID}表示应用ID，“indexName”、“indexDesc”、“indexType”表示索引名称、描述和类型。 响应示例 { "result": "SUCCESS", "data": [ { "id": "505115594543079424", "rdmExtensionType": "XDMSearchIndexEntity", "className": "XDMSearchIndexEntity", "searchServId": "505115507221864448", "indexName": "SampleIndex", "matchType": { "code": "fuzzy", "cnName": "模糊匹配", "enName": "fuzzy", "alias": "FUZZY" }, "displayUsage": true, "keywordUsage": true, "operator": null, "segOption": { "code": "notInvolved", "cnName": "不涉及", "enName": "notInvolved", "alias": "NOTINVOLVED" }, "indexMaxFieldSize": null, "indexType": { "code": "Text", "cnName": "文本", "enName": "Text", "alias": "TEXT" }, "indexDesc": "", "searchUsage": true, "segMethod": { "code": "noWord", "cnName": "不分词", "enName": "noWord", "alias": "NOWORD" }, "searchServName": "搜索服务示例", "inputSeparator": null, "relationIndexEntityList": null } ], "errors": [] }

响应示例 { "result": "SUCCESS", "data": [ { "id": "502903940749205504", "creator": "TestAccount2 5547b9adee54423cb**********", "modifier": "TestAccount2 5547b9adee54423cb**********", "createTime": "2023-05-24T10:00:42.978+0000", "lastUpdateTime": "2023-05-24T10:00:42.978+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Design_document", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2022-12-01T11:24:39.000+0000", "lastUpdateTime": "2022-12-01T11:24:39.000+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "Design_document", "name": "产品设计", "description": null, "kiaguid": null, "securityLevel": "internal", "income": null, "department": null } ], "errors": [] }

URI URI格式： POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/create 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。

请求参数 表2 请求body参数 参数 是否必填 参数类型 描述 id 是 Int 唯一编码。 rdmVersion 是 Int 系统版本。 rdmExtensionType 否 String 实体类型。 createTime 否 Date 创建时间。 creator 否 String 创建者。 lastUpdateTime 否 Date 最后更新时间。 modifier 否 String 更新者。 tenant 否 Object 租户。 根据实体类型、功能的不同，请求body参数不同，您可以在全量数据服务查看API具体参数。

请求示例 示例背景 假设，您已在cn-north-4区域的TestApp应用中，构建一个名称为“TestMV”的M-V模型数据实体，并完成了实体发布、应用发布和应用部署。希望对主对象ID为“492060584863342592”的A.1版本和A.2版本进行比较。 示例代码 { "params":{ "id":492060584863342592, "basicVersion":"A.1", "correlationVersion":"A.2" } }

响应示例 为篇幅起见，这里只展示部分内容。 { "result": "SUCCESS", "data": [ { ...... //返回基础版本对象版本号A.1的所有内容 }, { ...... //返回待比较版本对象版本号A.2的基本属性的区别 "relations": [ ...... //返回待比较版本对象版本号A.2的关联关系的区别（所有区别都是A.2与A.1对比后A.2的区别）。如需对比A.1的区别，传参时调换A.1和A.2的顺序，将A.2作为基础版本对象版本号，A.1作为待比较的版本对象的版本号即可。 ], "extAttrs": { ...... //返回待比较版本对象版本号A.2的扩展属性的区别 }, "latest": true, "lastUpdateTime": "2023-04-27 14:35:56" } ], "errors": [] }

URI URL格式： POST http://{Endpoint}/rdm_{appID}_app/publicservices/api/{entityName}/compareBusinessVersion 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。