EntityRemoveLabelsByUniqueAttribute interface
Methods
| delete(Entity |
Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| post(Entity |
Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| put(Entity |
Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
Method Details
delete(EntityRemoveLabelsByUniqueAttributeParameters)
Delete given labels to a given entity identified by its type and unique attribute.
If labels is null/empty, no labels will be removed.
If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function delete(options?: EntityRemoveLabelsByUniqueAttributeParameters): StreamableMethod<EntityRemoveLabelsByUniqueAttribute204Response | EntityRemoveLabelsByUniqueAttributeDefaultResponse>Parameters
Returns
post(EntitySetLabelsByUniqueAttributeParameters)
Set labels to a given entity identified by its type and unique attributes.
If labels is null/empty, existing labels will all be removed.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>.
NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function post(options?: EntitySetLabelsByUniqueAttributeParameters): StreamableMethod<EntitySetLabelsByUniqueAttribute204Response | EntitySetLabelsByUniqueAttributeDefaultResponse>Parameters
Returns
put(EntityAddLabelsByUniqueAttributeParameters)
Add given labels to a given entity identified by its type and unique attributes.
If labels is null/empty, no labels will be added.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>.
NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.
The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function put(options?: EntityAddLabelsByUniqueAttributeParameters): StreamableMethod<EntityAddLabelsByUniqueAttribute204Response | EntityAddLabelsByUniqueAttributeDefaultResponse>