EntityGetByUniqueAttributes interface
Métodos
| delete(Entity |
Exclua uma entidade identificada por seu tipo e atributos exclusivos. Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato: attr:<attrName>=<attrValue>. NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName. A solicitação REST teria a seguinte aparência: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| get(Entity |
Obtenha uma definição completa de uma entidade dado o seu tipo e atributo exclusivo. Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato: attr:<attrName>=<attrValue>. NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName. A solicitação REST teria a seguinte aparência: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
| put(Entity |
Atualizar entidade parcialmente - Permitir que um subconjunto de atributos seja atualizado em uma entidade que é identificada por seu tipo e atributo exclusivo, por exemplo: Referenceable.qualifiedName. Atualizações nulas não são possíveis. Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato: attr:<attrName>=<attrValue>. NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName. A solicitação REST teria a seguinte aparência: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. |
Detalhes de Método
delete(EntityDeleteByUniqueAttributeParameters)
Exclua uma entidade identificada por seu tipo e atributos exclusivos. Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato: attr:<attrName>=<attrValue>. NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName.
A solicitação REST teria a seguinte aparência: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function delete(options?: EntityDeleteByUniqueAttributeParameters): StreamableMethod<EntityDeleteByUniqueAttribute200Response | EntityDeleteByUniqueAttributeDefaultResponse>Parâmetros
Devoluções
get(EntityGetByUniqueAttributesParameters)
Obtenha uma definição completa de uma entidade dado o seu tipo e atributo exclusivo.
Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato: attr:<attrName>=<attrValue>.
NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName.
A solicitação REST teria a seguinte aparência: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function get(options?: EntityGetByUniqueAttributesParameters): StreamableMethod<EntityGetByUniqueAttributes200Response | EntityGetByUniqueAttributesDefaultResponse>Parâmetros
Devoluções
put(EntityPartialUpdateByUniqueAttributesParameters)
Atualizar entidade parcialmente - Permitir que um subconjunto de atributos seja atualizado em uma entidade que é identificada por seu tipo e atributo exclusivo, por exemplo: Referenceable.qualifiedName. Atualizações nulas não são possíveis.
Além do parâmetro typeName path, o(s) par(es) chave-valor de atributo podem ser fornecidos no seguinte formato:
attr:<attrName>=<attrValue>. NOTA: O attrName e attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName.
A solicitação REST teria a seguinte aparência: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
function put(options: EntityPartialUpdateByUniqueAttributesParameters): StreamableMethod<EntityPartialUpdateByUniqueAttributes200Response | EntityPartialUpdateByUniqueAttributesDefaultResponse>