EntityGetByUniqueAttributes interface
方法
| delete(Entity |
删除由其类型和唯一属性标识的实体。 除了 typeName 路径参数,还可以使用以下格式提供属性键值对:attr:<attrName>=<attrValue>。 注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。 REST 请求如下所示:DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。 |
| get(Entity |
获取给定实体类型和唯一属性的完整定义。 除了 typeName 路径参数,还可以使用以下格式提供属性键值对:attr:<attrName>=<attrValue>。 注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。 REST 请求如下所示:GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。 |
| put(Entity |
部分更新实体 - 允许在其类型和唯一属性(例如 Referenceable.qualifiedName)标识的实体上更新属性的子集。 无法进行 Null 更新。 除了 typeName 路径参数外,还可以采用以下格式提供属性键值对: attr:<attrName>=<attrValue>。 注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。 REST 请求如下所示:PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。 |
方法详细信息
delete(EntityDeleteByUniqueAttributeParameters)
删除由其类型和唯一属性标识的实体。 除了 typeName 路径参数,还可以使用以下格式提供属性键值对:attr:<attrName>=<attrValue>。 注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。
REST 请求如下所示:DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。
function delete(options?: EntityDeleteByUniqueAttributeParameters): StreamableMethod<EntityDeleteByUniqueAttribute200Response | EntityDeleteByUniqueAttributeDefaultResponse>
参数
返回
get(EntityGetByUniqueAttributesParameters)
获取给定实体类型和唯一属性的完整定义。
除了 typeName 路径参数,还可以使用以下格式提供属性键值对:attr:<attrName>=<attrValue>。
注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。
REST 请求如下所示:GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。
function get(options?: EntityGetByUniqueAttributesParameters): StreamableMethod<EntityGetByUniqueAttributes200Response | EntityGetByUniqueAttributesDefaultResponse>
参数
返回
put(EntityPartialUpdateByUniqueAttributesParameters)
部分更新实体 - 允许在其类型和唯一属性(例如 Referenceable.qualifiedName)标识的实体上更新属性的子集。 无法进行 Null 更新。
除了 typeName 路径参数外,还可以采用以下格式提供属性键值对:
attr:<attrName>=<attrValue>。 注意:attrName 和 attrValue 在实体中应是唯一的,例如。qualifiedName。
REST 请求如下所示:PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。
function put(options: EntityPartialUpdateByUniqueAttributesParameters): StreamableMethod<EntityPartialUpdateByUniqueAttributes200Response | EntityPartialUpdateByUniqueAttributesDefaultResponse>