Partilhar via


Xrm.WebApi.online.executeMultiple (referência da API do cliente)

Execute uma coleção de ações, funções ou operações CRUD.

Observação

Este método é suportado apenas para o modo online (Xrm.WebApi.online).

Se você quiser executar várias solicitações em uma transação, você deve passar um conjunto de alterações como um parâmetro para esse método. Os conjuntos de alterações representam uma coleção de operações que são executadas em uma transação. Você também pode passar solicitações individuais e alterar conjuntos juntos como parâmetros para esse método.

Observação

  • Não é possível incluir operações de leitura (recuperar, recuperar várias e funções da API da Web) como parte de um conjunto de alterações; isto é de acordo com as especificações OData v4.
  • As solicitações podem conter até 1.000 solicitações individuais e não podem conter outros lotes. Para obter mais informações: Executar operações em lote.

Sintaxe

Execute várias solicitações:

var requests = [req1, req2, req3];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Execute várias solicitações em uma transação:

Neste caso, req1, req2, e req3 são executados em uma transação.

var changeSet = [req1, req2, req3];
var requests = [changeSet];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Execute uma combinação de solicitações individuais e várias solicitações em uma transação:

Neste caso, req1, , e req3 são executados em transação, mas req4 e req5req2são executados individualmente.

var changeSet = [req1, req2, req3];
var requests = [req4, req5, changeset];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Obrigatório Description
requests Matriz de objetos Yes Uma matriz de um dos seguintes tipos:

Objetos em que cada objeto é uma ação, função ou solicitação CRUD que você deseja executar no ponto de extremidade da API Web. Cada objeto expõe um método getMetadata que permite definir os metadados para a ação, função ou solicitação CRUD que você deseja executar. O método execute aceita esse tipo de parâmetro.

Conjunto de alterações (uma matriz de objetos), onde cada objeto no conjunto de alterações é como explicado anteriormente. Nesse caso, todos os objetos de solicitação especificados no conjunto de alterações são executados em uma transação.

Encontre exemplos de solicitação na seção Sintaxe.
successCallback Função Não Uma função para chamar quando a operação é executada com êxito. Uma matriz de objetos de resposta é passada para a função. 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 uma promessa contendo uma matriz de objetos para o successCallback. Os objetos têm estas propriedades:

Nome Tipo Obrigatório Description
json Promessa Não Corpo da resposta no formato JSON.
text Promessa Não Corpo da resposta em formato de texto simples.
headers Objeto Yes Cabeçalhos de resposta.
ok booleano Yes Indica se a solicitação foi bem-sucedida.
status Número Yes Valor numérico no código de status da resposta. Por exemplo: 200
statusText String Yes Descrição do código de status da resposta. Por exemplo: OK
type String Yes Tipo de resposta. Os valores são: a cadeia de caracteres vazia (padrão), arraybuffer, blob, document, jsone text.
url String Yes URL de solicitação da ação, função ou solicitação CRUD que foi enviada para o ponto de extremidade da API Web.

Xrm.WebApi