Xrm.WebApi.online.execute (client-API-verwijzing)

Voer één actie, functie of CRUD-bewerking uit.

Opmerking

Deze methode wordt alleen ondersteund voor de onlinemodus (Xrm.WebApi.online).

Syntaxis

Xrm.WebApi.online.execute(request).then(successCallback, errorCallback);

Parameterwaarden

Naam	Typologie	Verplicht	Description
`request`	Object	Yes	Object dat u doorgeeft aan het web-API-eindpunt om een actie, functie of CRUD-aanvraag uit te voeren. Het object maakt een `getMetadata` methode beschikbaar via het prototype dat u gebruikt om de metagegevens te definiëren voor de actie, functie of CRUD-aanvraag die u wilt uitvoeren. Zie de methode request.getMetadata
`successCallback`	Functie	Nee.	Een functie om aan te roepen wanneer de bewerking is geslaagd. Zie Retourwaarde
`errorCallback`	Functie	Nee.	Een functie om aan te roepen wanneer de bewerking mislukt. Er wordt een object met de volgende eigenschappen doorgegeven: - `errorCode`:Getal. De foutcode als een positief decimaal getal. De foutcode die wordt beschreven zoals `0x80040333` wordt geretourneerd als `2147746611`. - `message`:Snaar. Een foutmelding die het probleem beschrijft.

methode request.getMetadata

De getMetadata methode heeft de volgende parameters:

Naam	Typologie	Verplicht	Description
`boundParameter`	Snaar / Touwtje	Nee.	De naam van de afhankelijke parameter voor de actie of functie die moet worden uitgevoerd. - Geef op `undefined` of u een CRUD-aanvraag uitvoert. - Geef op `null` of de actie of functie die moet worden uitgevoerd, niet is gebonden aan een tabel. - Geef op `entity` of de actie of functie die moet worden uitgevoerd afhankelijk is van een tabel.
`operationName`	Snaar / Touwtje	Nee.	Naam van de actie, functie of een van de volgende waarden als u een CRUD-aanvraag uitvoert: `Create`, `Retrieve`, `Update`of `Delete`.
`operationType`	Number	Nee.	Geeft het type bewerking aan dat u uitvoert. Geef een van de volgende waarden op: - `0`:Actie - `1`:Functie - `2`:CRUD
`parameterTypes`	Object	Yes	De metagegevens voor parametertypen. Het object heeft de volgende waarden: `enumProperties` : (Optioneel) Object. De metagegevens voor opsommingstypen. Het object heeft twee tekenreekswaarden: `name` en `value`. `structuralProperty` :Getal. De categorie van het parametertype. Geef een van de volgende waarden op: - `0`:Onbekend - `1`: PrimitiveType - `2`: ComplexType - `3`: Opsommingstype - `4`:Collectie - `5`: EntityType `typeName` :Snaar. De volledig gekwalificeerde naam van het parametertype.

Retourwaarde

Retourneert bij succes een promise-object aan de successCallback hand van de volgende eigenschappen:

Naam	Typologie	Description
`body`(Afgeschaft)	Object	Hoofdtekst van antwoord.
`headers`	Object	Antwoordheaders.
`ok`	Booleaan	Geeft aan of de aanvraag is geslaagd.
`status`	Number	Numerieke waarde in de antwoordstatuscode. Bijvoorbeeld: `200`
`statusText`	Snaar / Touwtje	Beschrijving van de antwoordstatuscode. Bijvoorbeeld: `OK`
`type`(Afgeschaft)	Snaar / Touwtje	Antwoordtype. Waarden zijn: de lege tekenreeks (standaard), `arraybuffer`, `blob`, `document`, `json`en `text`.
`url`	Snaar / Touwtje	Aanvraag-URL van de actie, functie of CRUD-aanvraag die u naar het web-API-eindpunt hebt verzonden.
`json`	Beloven	De parameter voor de callback-gemachtigde is van het type elk (JSON-object).
`text`	Beloven	De parameter voor de callback-gemachtigde is een tekenreeks.

Voorbeelden

Zoek deze voorbeelden in de volgende secties:

Example	Demonstreert
Een actie uitvoeren	De actie uitvoeren `WinOpportunity` om een verkoopkans te markeren als gewonnen.
Een functie uitvoeren	De functies `CalculateRollupField`en `RetrieveDuplicatesInitializeFrom` functies uitvoeren `WhoAmI`en hun antwoorden lezen.
Een record maken	Een accountrecord maken met behulp van een aanvraagobject.
Een record ophalen	De naam van een accountrecord ophalen door de id en de kolommen op te geven die moeten worden geretourneerd.
Een record bijwerken	De naam van een accountrecord bijwerken met behulp van een aanvraagobject.
Een record verwijderen	Een accountrecord verwijderen door de bijbehorende tabel en id op te geven.
Een record koppelen	Een account koppelen aan meerdere contactpersonen via een navigatie-eigenschap met een verzamelingswaarde.
Een record ontkoppelen	De koppeling tussen een account en één contactpersoon verwijderen via een navigatie-eigenschap met een verzamelingswaarde.

Aanbeveling

Gebruik de Dataverse REST Builder om JavaScript-code te genereren die gebruikmaakt van de Xrm.WebApi.online.execute methode.

Een voorbeeld van een actie uitvoeren

In het volgende voorbeeld ziet u hoe u de WinOpportunity actie uitvoert die is gevonden in de oplossing Dynamics 365 for Sales. Het aanvraagobject wordt gemaakt op basis van de actiedefinitie in niet-afhankelijke acties.

var Sdk = window.Sdk || {};
/**
 * Request to win an opportunity
 * @param {Object} opportunityClose - The opportunity close activity associated with this state change.
 * @param {number} status - Status of the opportunity.
 */
Sdk.WinOpportunityRequest = function(opportunityClose, status) {
    this.OpportunityClose = opportunityClose;
    this.Status = status;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.WinOpportunityRequest.prototype.getMetadata = function () {
    return {
        boundParameter: null,
        parameterTypes: {
            "OpportunityClose": {
                "typeName": "mscrm.opportunityclose",
                "structuralProperty": 5 // Entity Type
            },
            "Status": {
                "typeName": "Edm.Int32",
                "structuralProperty": 1 // Primitive Type
            }
        },
        operationType: 0, // This is an action. Use '1' for functions and '2' for CRUD
        operationName: "WinOpportunity",
    };
};

var opportunityClose = {
    "opportunityid@odata.bind": "/opportunities(c60e0283-5bf2-e311-945f-6c3be5a8dd64)",
    "description": "Product and maintenance for 2018",
    "subject": "Contract for 2018"
}

// Construct a request object from the metadata
var winOpportunityRequest = new Sdk.WinOpportunityRequest(opportunityClose, 3);

// Use the request object to execute the function
Xrm.WebApi.online.execute(winOpportunityRequest).then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);
        // The WinOpportunityRequest does not return any response body content. So we
        // need not access the response.json() property.

        // Perform other operations as required.
    }
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Een voorbeeld van een functie uitvoeren

In het volgende voorbeeld ziet u hoe u de functie WhoAmI uitvoert:

var Sdk = window.Sdk || {};
/**
 * Request to execute WhoAmI function
 */
Sdk.WhoAmIRequest = function () { };

// NOTE: The getMetadata property should be attached to the function prototype instead of the
//       function object itself.
Sdk.WhoAmIRequest.prototype.getMetadata = function () {
    return {
        boundParameter: null,
        parameterTypes: {},
        operationType: 1, // This is a function. Use '0' for actions and '2' for CRUD
        operationName: "WhoAmI",
    };
};

// Construct a request object from the metadata
var whoAmIRequest = new Sdk.WhoAmIRequest();

// Use the request object to execute the function
Xrm.WebApi.online.execute(whoAmIRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // Use response.json() to access the content of the response body.
        return response.json();
    }
}
)
.then(function (responseBody) {
    console.log("User Id: %s", responseBody.UserId);
    // perform other operations as required;
})
.catch(function (error) {
    console.log(error.message);
    // handle error conditions
});

In het volgende voorbeeld ziet u hoe u de CalculateRollupField functie uitvoert:

var Sdk = window.Sdk || {};

Sdk.CalculateRollupFieldRequest = function(target, fieldName) {
    this.Target = target;
    this.FieldName = fieldName;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
//       function object itself.
Sdk.CalculateRollupFieldRequest.prototype.getMetadata = function() {
    return {
        boundParameter: null,
        parameterTypes: {
            "Target": {
                "typeName": "mscrm.crmbaseentity",
                "structuralProperty": 5
            },
            "FieldName": {
                "typeName": "Edm.String",
                "structuralProperty": 1
            }
        },
        operationType: 1, // This is a function. Use '0' for actions and '2' for CRUD
        operationName: "CalculateRollupField"
    };
};

// Create variables to point to a quote record and to a specific column
var quoteId = {
    "@odata.type": "Microsoft.Dynamics.CRM.quote",
    "quoteid": "7bb01e55-2394-ea11-a811-000d3ad97943"
};

// The roll-up column for which we want to force a re-calculation
var fieldName = "new_test_rollup";

// Create variable calculateRollupFieldRequest and pass those variables created above
var calculateRollupFieldRequest = new Sdk.CalculateRollupFieldRequest(quoteId, fieldName);

// Use the request object to execute the function
Xrm.WebApi.online.execute(calculateRollupFieldRequest)
.then(function(response) {
    if (response.ok) { // If a response was received.
        console.log("Status: %s %s", response.status, response.statusText);

        // Use response.json() to access the content of the response body.
        return response.json();
    }
})
.then(function(responseBody) { 
    //Do something with the response
    console.log("The response is: %s", responseBody);
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

In het volgende voorbeeld ziet u hoe u de RetrieveDuplicates functie uitvoert:

var Sdk = window.Sdk || {};

Sdk.RetrieveDuplicatesRequest = function(businessEntity, matchingEntityName, pagingInfo) {
    this.BusinessEntity = businessEntity;
    this.MatchingEntityName = matchingEntityName;
    this.PagingInfo = pagingInfo;

};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.RetrieveDuplicatesRequest.prototype.getMetadata = function() {
    return {
        boundParameter: null,
        parameterTypes: {
            "BusinessEntity": {
                "typeName": "mscrm.crmbaseentity",
                "structuralProperty": 5 // Entity Type
            },
            "MatchingEntityName": {
                "typeName": "Edm.String",
                "structuralProperty": 1 // Primitive Type
            },
            "PagingInfo": {
                "typeName:": "mscrm.PagingInfo", // Complex Type
                "structuralProperty": 5
            }
        },
        operationType: 1, // This is a function. Use '0' for actions and '2' for CRUD
        operationName: "RetrieveDuplicates",
    };
};

// Create a variable to point to a contact record and with specific data in the needed columns
var contactRecord = {
    "@odata.type": "Microsoft.Dynamics.CRM.contact",
    "firstname": "Test",
    "lastname": "Account"
};

// Create a paging object to keep track of the current page and how many records we get per page
var pagingInfo = {
    "PageNumber": 1,
    "Count": 10
};

// Create the variable retrieveDuplicatesRequest to build the request
var retrieveDuplicatesRequest = new Sdk.RetrieveDuplicatesRequest(contactRecord, "contact", pagingInfo);

// Use the request object to execute the function
Xrm.WebApi.online.execute(retrieveDuplicatesRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // Use response.json() to access the content of the response body.
        return response.json();
    }
})
.then(function(responseBody) { 
    // Do something with the response
    console.log("The response is: %s", responseBody);
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

In het volgende voorbeeld ziet u hoe u de InitializeFrom functie uitvoert:

var Sdk = window.Sdk || {};

Sdk.InitializeFromRequest = function (
  entityMoniker,
  targetEntityName,
  targetFieldType
) {
  this.EntityMoniker = entityMoniker;
  this.TargetEntityName = targetEntityName;
  this.TargetFieldType = targetFieldType;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.InitializeFromRequest.prototype.getMetadata = function () {
  return {
    boundParameter: null,
    parameterTypes: {
      EntityMoniker: {
        typeName: "mscrm.crmbaseentity",
        structuralProperty: 5, //Entity Type
      },
      TargetEntityName: {
        typeName: "Edm.String",
        structuralProperty: 1, // PrimitiveType
      },
      TargetFieldType: {
        typeName: "Microsoft.Dynamics.CRM.TargetFieldType",
        structuralProperty: 3, // Enum Type
        enumProperties: [
          {
            name: "All",
            value: 0,
          },
          {
            name: "ValidForCreate",
            value: 1,
          },
          {
            name: "ValidForUpdate",
            value: 2,
          },
          {
            name: "ValidForRead",
            value: 3,
          },
        ],
      },
    },
    operationType: 1, // This is a function. Use '0' for actions and '2' for CRUD
    operationName: "InitializeFrom",
  };
};

// Create a variable to point to tje parent account record
var parentAccountRecord = {
  "@odata.type": "Microsoft.Dynamics.CRM.account",
  accountid: "141da047-eaad-eb11-b1b4-000d3ac581a0",
};

// Create a variable for the target entity name
var targetEntityName = "account";

// Create a variable for the target field type
var targetFieldType = 0;

// Build the request
var initializeFromRequest = new Sdk.InitializeFromRequest(
  parentAccountRecord,
  targetEntityName,
  targetFieldType
);

// Execute the request
Xrm.WebApi.online.execute(initializeFromRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // Use response.json() to access the content of the response body.
        return response.json();
    }
})
.then(function(responseBody) { 
    // Do something with the response
    console.log("The response is: %s", responseBody);
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

CRUD-bewerkingen uitvoeren

Een recordvoorbeeld maken

In het volgende voorbeeld ziet u hoe u een maakbewerking uitvoert.

var Sdk = window.Sdk || {};

/**
 * Request to execute a create operation
 */
Sdk.CreateRequest = function(entityName, payload) {
    this.etn = entityName;
    this.payload = payload;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.CreateRequest.prototype.getMetadata = function () {
    return {
        boundParameter: null,
        parameterTypes: {},
        operationType: 2, // This is a CRUD operation. Use '0' for actions and '1' for functions
        operationName: "Create",
    };
};
// Construct a request object from the metadata
var payload = {
    name: "Fabrikam Inc."
};
var createRequest = new Sdk.CreateRequest("account", payload);

// Use the request object to execute the function
Xrm.WebApi.online.execute(createRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);
        
        // The Create request does not return any response body content. So we
        // need not access the response.json() property.

        // Perform other operations as required.
    }
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Een recordvoorbeeld ophalen

In het volgende voorbeeld ziet u hoe u een ophaalbewerking uitvoert.

var Sdk = window.Sdk || {};

/**
 * Request to execute a retrieve operation
 */
Sdk.RetrieveRequest = function(entityReference, columns) {
    this.entityReference = entityReference;
    this.columns = columns;
};
// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.RetrieveRequest.prototype.getMetadata = function () {
    return {
        boundParameter: null,
        parameterTypes: {},
        operationType: 2, // This is a CRUD operation. Use '0' for actions and '1' for functions
        operationName: "Retrieve",
    };
};

// Construct request object from the metadata
var entityReference = {
    entityType: "account",
    id: "d2b6c3f8-b0fa-e911-a812-000d3a59fa22"
};
var retrieveRequest = new Sdk.RetrieveRequest(entityReference, ["name"]);

// Use the request object to execute the function
Xrm.WebApi.online.execute(retrieveRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // Use response.json() to access the content of the response body.
        return response.json();
    }
})
.then(function(responseBody) {
    console.log("Name: %s", responseBody.name);
    
    // perform other operations as required;
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Voorbeeld van een record bijwerken

In het volgende voorbeeld ziet u hoe u een updatebewerking uitvoert.

var Sdk = window.Sdk || {};


/**
 * Request to execute an update operation
 */
Sdk.UpdateRequest = function(entityName, entityId, payload) {
    this.etn = entityName;
    this.id = entityId;
    this.payload = payload;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.UpdateRequest.prototype.getMetadata = function () {
    return {
        boundParameter: null,
        parameterTypes: {},
        operationType: 2, // This is a CRUD operation. Use '0' for actions and '1' for functions
        operationName: "Update",
    };
};

// Construct a request object from the metadata
var payload = {
    name: "Updated Sample Account"
};
var updateRequest = new Sdk.UpdateRequest("account", "d2b6c3f8-b0fa-e911-a812-000d3a59fa22", payload);

// Use the request object to execute the function
Xrm.WebApi.online.execute(updateRequest)
.then(function (response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // The Update request does not return any response body content. So we
        // need not access the response.json() property.
        
        // perform other operations as required;
    }
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Een recordvoorbeeld verwijderen

In het volgende voorbeeld ziet u hoe u een verwijderbewerking uitvoert.

var Sdk = window.Sdk || {};

/**
 * Request to execute a delete operation
 */
Sdk.DeleteRequest = function(entityReference) {
    this.entityReference = entityReference;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.DeleteRequest.prototype.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2, // This is a CRUD operation. Use '0' for actions and '1' for functions
            operationName: "Delete",
        };
    };
};
};

// Construct request object from the metadata
var entityReference = {
    entityType: "account",
    id: "d2b6c3f8-b0fa-e911-a812-000d3a59fa22"
};
var deleteRequest = new Sdk.DeleteRequest(entityReference);

// Use the request object to execute the function
Xrm.WebApi.online.execute(deleteRequest)
.then(function(response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);
        
        // The Delete request does not return any response body content. So we
        // need not access the response.json() property.

        // perform other operations as required;
    }
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Voorbeeld van een record koppelen

In het volgende codevoorbeeld ziet u hoe u een koppelingsbewerking uitvoert op eigenschappen van navigatie met een verzamelingswaarde (een-op-veel- en veel-op-veel-relaties). Voor navigatie-eigenschappen met één waarde (veel-op-een-relaties, ook wel opzoekkolommen genoemd), kunt u een updatebewerking uitvoeren zoals eerder wordt weergegeven of Xrm.WebApi.updateRecord gebruiken.

var Sdk = window.Sdk || {};

/*
 * Request to execute an Associate operation.
 */
Sdk.AssociateRequest = function(target, relatedEntities, relationship) {
    this.target = target;
    this.relatedEntities = relatedEntities;
    this.relationship = relationship;
};

// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.AssociateRequest.prototype.getMetadata = function() {
    return {
        boundParameter: null,
        parameterTypes: {},
        operationType: 2, // Associate and Disassociate fall under the CRUD umbrella
        operationName: "Associate"
    }
};

// Construct the target EntityReference object
var target = {
    entityType: "account",
    id: "0b4abc7d-7619-eb11-8dff-000d3ac5c7f9"
};

// Construct the related EntityReferences that the Target will be associated with.
var relatedEntities = [
    {
        entityType: "contact",
        id: "180a9aad-7619-eb11-8dff-000d3ac5c7f9"
    },
    {
        entityType: "contact",
        id: "753c58b4-7619-eb11-8dff-000d3ac5c7f9"
    }
];

// The name of the existing relationship to associate on.
var relationship = "new_account_contact";

var manyToManyAssociateRequest = new Sdk.AssociateRequest(target, relatedEntities, relationship)

Xrm.WebApi.online.execute(manyToManyAssociateRequest)
.then(function(response) {
    if (response.ok) {
        console.log("Status: %s %s", response.status, response.statusText);

        // The Associate request does not return any response body content. So we
        // need not access the response.json() property.

        // perform other operations as required;
    }
})
.catch(function(error) {
    console.log(error.message);
    // handle error conditions
});

Voorbeeld van een record ontkoppelen

In het volgende codevoorbeeld ziet u hoe u een losgekoppelde bewerking uitvoert op eigenschappen van navigatie met verzamelingswaarden (een-op-veel- en veel-op-veel-relaties). Voor navigatie-eigenschappen met één waarde (veel-op-een-relaties, ook wel opzoekkolommen genoemd), kunt u een updatebewerking uitvoeren zoals eerder wordt weergegeven of Xrm.WebApi.updateRecord gebruiken.