Partilhar via


deleteRecord (referência da API do cliente)

Exclui um registro de tabela.

Sintaxe

Xrm.WebApi.deleteRecord(entityLogicalName, id).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Obrigatório Description
entityLogicalName String Yes O nome lógico da tabela do registro que você deseja excluir. Por exemplo: account.
id String Yes GUID do registro de tabela que você deseja excluir.
successCallback Função Não Uma função para chamar quando um registro é excluído. Ver Valor de Retorno
errorCallback Função Não Uma função para chamar quando a operação falhar. Um objeto com as seguintes propriedades é passado:
- errorCode: Número. O código de erro como um número decimal positivo. Por exemplo, o código de erro documentado como 0x80040333 será retornado como 2147746611.
- message: String. Uma mensagem de erro descrevendo o problema.

Valor de retorno

Quando for bem-sucedido, retorna um objeto promise para o successCallback com as seguintes propriedades:

Nome Tipo Description
entityType String O nome lógico da tabela do registro.
id String GUID do registro.
name String Nome do registo.

Examples

Esses exemplos usam alguns dos mesmos objetos de solicitação, conforme demonstrado em Atualizar e excluir tabelas usando a API da Web para definir o objeto de dados para atualizar um registro de entidade.

Exclui uma conta com ID de registro = 5531d753-95af-e711-a94e-000d3a11e605.

Xrm.WebApi.deleteRecord("account", "5531d753-95af-e711-a94e-000d3a11e605").then(
    function success(result) {
        console.log("Account deleted");
        // perform operations on record deletion
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Xrm.WebApi