EntityGetByUniqueAttributes interface
Methoden
| delete(Entity |
Löschen Sie eine Entität, die durch ihren Typ und eindeutige Attribute identifiziert wird. Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden: attr:<attrName>=<attrValue>. HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName. Die REST-Anforderung würde ungefähr wie folgt aussehen: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| get(Entity |
Rufen Sie die vollständige Definition einer Entität anhand des Typs und des eindeutigen Attributs ab. Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden: attr:<attrName>=<attrValue>. HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName. Die REST-Anforderung würde ungefähr wie folgt aussehen: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| put(Entity |
Entität teilweise aktualisieren – Zulassen, dass eine Teilmenge von Attributen für eine Entität aktualisiert wird, die durch den Typ und das eindeutige Attribut identifiziert wird, z. B.: Referenceable.qualifiedName. Null-Updates sind nicht möglich. Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden: attr:<attrName>=<attrWert>. HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName. Die REST-Anforderung würde ungefähr wie folgt aussehen: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
Details zur Methode
delete(EntityDeleteByUniqueAttributeParameters)
Löschen Sie eine Entität, die durch ihren Typ und eindeutige Attribute identifiziert wird. Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden: attr:<attrName>=<attrValue>. HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName.
Die REST-Anforderung würde ungefähr wie folgt aussehen: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function delete(options?: EntityDeleteByUniqueAttributeParameters): StreamableMethod<EntityDeleteByUniqueAttribute200Response | EntityDeleteByUniqueAttributeDefaultResponse>
Parameter
Gibt zurück
get(EntityGetByUniqueAttributesParameters)
Rufen Sie die vollständige Definition einer Entität anhand des Typs und des eindeutigen Attributs ab.
Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden: attr:<attrName>=<attrValue>.
HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName.
Die REST-Anforderung würde ungefähr wie folgt aussehen: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function get(options?: EntityGetByUniqueAttributesParameters): StreamableMethod<EntityGetByUniqueAttributes200Response | EntityGetByUniqueAttributesDefaultResponse>
Parameter
Gibt zurück
put(EntityPartialUpdateByUniqueAttributesParameters)
Entität teilweise aktualisieren – Zulassen, dass eine Teilmenge von Attributen für eine Entität aktualisiert wird, die durch den Typ und das eindeutige Attribut identifiziert wird, z. B.: Referenceable.qualifiedName. Null-Updates sind nicht möglich.
Zusätzlich zum Parameter "typeName path" können Attributschlüsselwertpaare im folgenden Format bereitgestellt werden:
attr:<attrName>=<attrWert>. HINWEIS: Der AttrName und attrValue sollten für Entitäten eindeutig sein, z. B. qualifiedName.
Die REST-Anforderung würde ungefähr wie folgt aussehen: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function put(options: EntityPartialUpdateByUniqueAttributesParameters): StreamableMethod<EntityPartialUpdateByUniqueAttributes200Response | EntityPartialUpdateByUniqueAttributesDefaultResponse>