文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 基础数据服务/ 根据唯一键为“是”的属性更新实例数据
更新时间:2024-09-05 GMT+08:00
分享

根据唯一键为“是”的属性更新实例数据

功能介绍

当数据模型中存在“唯一键”为“是”的属性时,可根据该属性的英文名称更新该数据模型中实例的所有字段数据。如果更新的实例不存在,系统将自动创建该实例数据。

调用此接口时,建议传入该实例的所有字段信息。如果未传入某个字段,该字段的数据将更新为空值。

接口约束

不涉及。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/saveAll

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

参数解释:

应用唯一标识。

约束限制:

不涉及。

取值范围:

由英文字母和数字组成,且长度为32个字符。

默认取值:

不涉及。

modelName

String

参数解释:

数据模型的英文名称。

约束限制:

不涉及。

取值范围:

大写字母开头,只能包含字母、数字、"_",且长度为[1-60]个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

IAM用户的token。

获取方法请参见获取IAM用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

参数解释

应用ID。

约束限制

不涉及。

取值范围

由英文字母和数字组成,且长度为32个字符。

默认取值

不涉及。

params

Array of PersistableModelSaveAllDTO objects

参数解释:

请求参数对象。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 PersistableModelSaveAllDTO

参数

是否必选

参数类型

描述

createTime

String

参数解释:

创建时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

creator

Long

参数解释:

创建者。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

id

String

参数解释:

唯一标识。

约束限制:

不涉及。

取值范围:

-9223372036854775808到9223372036854775807的整数。

默认取值:

不涉及。

lastUpdateTime

String

参数解释:

最后更新时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

modifier

String

参数解释:

更新者。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

needSetNullAttrs

Array of strings

参数解释:

设置NULL值的属性名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

rdmExtensionType

String

参数解释:

扩展类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

tenant

ObjectReferenceParamDTO object

参数解释:

租户信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

uniqueKey

String

参数解释:

示例模型的唯一键属性。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 ObjectReferenceParamDTO

参数

是否必选

参数类型

描述

clazz

String

参数解释:

类名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

id

String

参数解释:

数据实例ID。

约束限制:

不涉及。

取值范围:

-9223372036854775808到9223372036854775807的整数。

默认取值:

不涉及。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

result

String

参数解释:

请求结果。

取值范围:

  • SUCCESS:请求成功。

  • FAIL:请求失败。

默认取值:

不涉及。

data

Array of longs

参数解释:

请求数据。

约束限制:

不涉及。

默认取值:

不涉及。

errors

Array of strings

参数解释:

异常信息。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/saveAll

{
  "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
  "params" : [ {
    "id" : "1",
    "modifier" : "test1",
    "creator" : "test1",
    "rdmExtensionType" : "PersistableModel",
    "uniqueKey" : "saveAll接口通过唯一键更新所有值",
    "tenant" : {
      "id" : "-1",
      "clazz" : "Tenant"
    }
  } ]
}

响应示例

状态码: 200

OK

{
  "result" : "SUCCESS",
  "data" : [ 1 ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档