Napomena
Za pristup ovoj stranici potrebna je autorizacija. Možete se pokušati prijaviti ili promijeniti direktorije.
Za pristup ovoj stranici potrebna je autorizacija. Možete pokušati promijeniti direktorije.
Izvršavanje jedne akcije, funkcije ili operacije CRUD.
Napomena
Ta je metoda podržana samo za mrežni način rada (Xrm.WebApi.online).
Sintaksa
Xrm.WebApi.online.execute(request).then(successCallback, errorCallback);
Parametri
| Ime | Tip | Obvezno | Opis |
|---|---|---|---|
request |
Objekt | Da | Objekt koji proslijedite krajnjoj točki API-ja za web radi izvršenja akcije, funkcije ili zahtjeva za CRUD. Objekt izlaže metodu getMetadata putem svog prototipa koji koristite za definiranje metapodataka za akciju, funkciju ili CRUD zahtjev koji želite izvršiti. Pogledajte request.getMetadata metodu |
successCallback |
Function | Ne | Funkcija koja se poziva kada operacija uspije. Pogledajte povratnu vrijednost |
errorCallback |
Function | Ne | Funkcija za pozivanje kada operacija ne uspije. Prosljeđuje se objekt sa sljedećim svojstvima: - errorCode:Broj. Kôd pogreške kao pozitivan decimalni broj. Primjerice, kôd pogreške dokumentiran kao 0x80040333 će se vratiti kao 2147746611.- message:Gudački. Poruka o pogrešci koja opisuje problem. |
request.getMetadata metoda
Metoda getMetadata ima sljedeće parametre:
| Ime | Tip | Obvezno | Opis |
|---|---|---|---|
boundParameter |
String | Ne | Naziv povezanog parametra za akciju ili funkciju koja će se izvršiti. - Navedite undefined izvršavate li CRUD zahtjev.- Navedite null nije li akcija ili funkcija koja će se izvršiti povezana ni s jednom tablicom.- Navedite entity je li akcija ili funkcija koja će se izvršiti povezana s tablicom. |
operationName |
String | Ne | Naziv akcije, funkcije ili neke od sljedećih vrijednosti ako izvršavate CRUD zahtjev: Create, Retrieve, , Updateili Delete. |
operationType |
Broj | Ne | Označava vrstu operacije koju izvršavate. Navedite jednu od sljedećih vrijednosti: - 0:Akcija- 1:Funkcija- 2: Crud (crud) |
parameterTypes |
Objekt | Da | Metapodaci za vrste parametara. Objekt ima sljedeće vrijednosti:enumProperties : (Neobavezno) Objekt. Metapodaci za vrste numeratora. Objekt ima dvije vrijednosti niza: name i value.structuralProperty :Broj. Kategorija vrste parametra. Navedite jednu od sljedećih vrijednosti:- 0:Nepoznat- 1: Jednostavne vrste- 2: ComplexType- 3: EnumerationType- 4:Zbirka- 5: EntityTypetypeName :Gudački. Puni naziv vrste parametra. |
Povratna vrijednost
Nakon uspjeha vraća objekt obećanja sljedećim successCallback svojstvima:
| Ime | Tip | Opis |
|---|---|---|
body(Zastarjelo) |
Objekt | Tijelo odgovora. |
headers |
Objekt | Zaglavlja odgovora. |
ok |
Booleov | Označava je li zahtjev uspio. |
status |
Broj | Brojčana vrijednost u kodu stanja odgovora. Npr: 200 |
statusText |
String | Opis koda statusa odgovora. Npr: OK |
type(Zastarjelo) |
String | Vrsta odgovora. Vrijednosti su: prazan niz (zadano), arraybuffer, blob, document, jsoni text. |
url |
String | Zatražite URL akcije, funkcije ili CRUD zahtjeva koji ste poslali na krajnju točku API-ja za web. |
json |
Obećanje | Parametar delegata za povratni poziv vrsta je bilo kojeg (JSON objekta). |
text |
Obećanje | Parametar delegata za povratni poziv jest niz. |
Primjeri
Ove primjere potražite u sljedećim odjeljcima:
| Primjer | Pokazuje |
|---|---|
| Izvršavanje akcije | Kako izvršiti akciju WinOpportunity za označavanje prilike kao pobijedio. |
| Izvršavanje funkcije | Kako izvršiti WhoAmIfunkcije , CalculateRollupField, RetrieveDuplicatesi InitializeFrom čitati njihove odgovore. |
| Stvaranje zapisa | Kako stvoriti zapis računa pomoću objekta zahtjeva. |
| Dohvaćanje zapisa | Dohvaćanje naziva zapisa računa navođenjem ID-a i stupaca koji će se vratiti. |
| Ažuriranje zapisa | Kako ažurirati naziv zapisa računa pomoću objekta zahtjeva. |
| Brisanje zapisa | Brisanje zapisa računa navođenjem tablice i ID-a. |
| Pridruživanje zapisa | Kako povezati račun s više kontakata putem navigacijskog svojstva s vrijednostima zbirke. |
| Razdruživanje zapisa | Upute za uklanjanje veze između računa i jednog kontakta putem navigacijskog svojstva s vrijednostima zbirke. |
Savjet
Upotrijebite Dataverse REST Builder za generiranje JavaScript koda koji koristi tu Xrm.WebApi.online.execute metodu.
Izvršavanje primjera akcije
Sljedeći primjer pokazuje kako izvršiti akciju pronađenu WinOpportunity u rješenju Dynamics 365 for Sales. Objekt zahtjeva stvara se na temelju definicije akcije u nepovezanih akcija.
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
});
Izvršavanje primjera funkcije
Sljedeći primjer pokazuje kako izvršiti funkciju WhoAmI:
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
});
U sljedećem se primjeru pokazuje kako izvršiti CalculateRollupField funkciju:
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
});
U sljedećem se primjeru pokazuje kako izvršiti RetrieveDuplicates funkciju:
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
});
U sljedećem se primjeru pokazuje kako izvršiti InitializeFrom funkciju:
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
});
Izvođenje CRUD operacija
Stvaranje primjera zapisa
U sljedećem se primjeru pokazuje kako izvesti operaciju stvaranja.
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
});
Dohvaćanje primjera zapisa
U sljedećem se primjeru pokazuje kako izvesti operaciju dohvaćanja.
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
});
Ažuriranje primjera zapisa
Sljedeći primjer pokazuje kako izvesti operaciju ažuriranja.
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
});
Brisanje primjera zapisa
U sljedećem se primjeru pokazuje kako izvesti operaciju brisanja.
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
});
Povezivanje primjera zapisa
Sljedeći primjer koda pokazuje kako izvesti operaciju pridruživanja na navigacijskim svojstvima s vrijednostima zbirke (odnosi jedan-prema-više i više-prema-više). Za navigacijska svojstva s jednom vrijednošću (odnosi više-prema-jedan, nazivaju se i stupci pretraživanja), možete izvesti operaciju ažuriranja kao što je prikazano ranije ili koristiti Xrm.WebApi.updateRecord.
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
});
Razdruživanje primjera zapisa
Sljedeći primjer koda pokazuje kako izvesti postupak razdruživanja na navigacijskim svojstvima s vrijednostima zbirke (odnosi jedan-prema-više i više-prema-više). Za navigacijska svojstva s jednom vrijednošću (odnosi više-prema-jedan, nazivaju se i stupci pretraživanja), možete izvesti operaciju ažuriranja kao što je prikazano ranije ili koristiti Xrm.WebApi.updateRecord.
Napomena
Za razliku od operacije pridruživanja, koju možete koristiti za povezivanje zapisa ciljnog entiteta s više povezanih zapisa entiteta u jednoj operaciji, operacija razdruživanja može razdruživati samo jedan zapis entiteta od zapisa ciljnog entiteta u svakoj operaciji.
var Sdk = window.Sdk || {};
/*
* Request to execute a Disassociate operation.
*/
Sdk.DisassociateRequest = function(target, relatedEntityId, relationship) {
this.target = target;
this.relatedEntityId = relatedEntityId;
this.relationship = relationship;
};
// NOTE: The getMetadata property should be attached to the function prototype instead of the
// function object itself.
Sdk.DisassociateRequest.prototype.getMetadata = function() {
return {
boundParameter: null,
parameterTypes: {},
operationType: 2, // Associate and Disassociate fall under the CRUD umbrella
operationName: "Disassociate"
}
};
// Construct the target EntityReference object
var target = {
entityType: "account",
id: "0b4abc7d-7619-eb11-8dff-000d3ac5c7f9"
};
// The GUID of the related entity record to disassociate.
var relatedEntityId = "180a9aad-7619-eb11-8dff-000d3ac5c7f9";
// The name of the existing relationship to disassociate from.
var relationship = "new_account_contact";
var manyToManyDisassociateRequest = new Sdk.DisassociateRequest(target, relatedEntityId, relationship)
Xrm.WebApi.online.execute(manyToManyDisassociateRequest)
.then(function(response) {
if (response.ok) {
console.log("Status: %s %s", response.status, response.statusText);
// The Disassociate 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
});