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>