Xrm.WebApi.online.execute (klienta API atsauce)

Izpildīt vienu darbību, funkciju vai CRUD operāciju.

Piezīmes

Šī metode tiek atbalstīta tikai tiešsaistes režīmā (Xrm.WebApi.online).

Sintakse

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

Parametrus

Vārds Tips Nepieciešams Apraksts
request Objektu Jā Objekts, ko nodod Web API galapunktam, lai izpildītu darbību, funkciju vai CRUD pieprasījumu. Objekts caur savu prototipu atklāj getMetadata metodi, kuru izmanto, lai definētu metadatus darbībai, funkcijai vai CRUD pieprasījumam, ko vēlies izpildīt. Skatīt request.getMetadata metodi
successCallback Function Nē Funkcija, kas jāizsauc, kad operācija ir veiksmīga. Skatīt atgriezto vērtību
errorCallback Function Nē Funkcija, kas jāizsauc, ja operācija neizdodas. Tiek nodots objekts ar šādām īpašībām:
- errorCode:Skaitlis. Kļūdas kods kā pozitīvs decimālskaitlis. Piemēram, kļūdas kods, kas dokumentēts kā 0x80040333 , tiks atgriezts kā 2147746611.
- message:Virkne. Kļūdas ziņojums, kurā aprakstīta problēma.

request.getMetadata metode

Metodei getMetadata ir šādi parametri:

Vārds Tips Nepieciešams Apraksts
boundParameter String Nē Izpildāmās darbības vai funkcijas saistītā parametra nosaukums.
- Norādiet undefined , vai izpildāt CRUD pieprasījumu.
- Norādīt null , vai izpildāmā darbība vai funkcija nav piesaistīta kādai tabulai.
- Norādīt entity , vai izpildāmā darbība vai funkcija ir saistīta ar tabulu.
operationName String Nē Darbības, funkcijas vai kādas no šādām vērtībām, ja izpildāt CRUD pieprasījumu, nosaukums: Create, Retrieve, Update, vai Delete.
operationType Numurs Nē Tas norāda, kāda veida operāciju jūs veicat. Norādiet vienu no šīm vērtībām:
- 0:Darbība
- 1:Funkcija
- 2: CRUD
parameterTypes Objektu Jā Parametru tipu metadati. Objektam ir šādas vērtības:
enumProperties : (neobligāts) objekts. Uzskaitījuma tipu metadati. Objektam ir divas virkņu vērtības: name un value.
structuralProperty :Skaitlis. Parametra tipa kategorija. Norādiet vienu no šīm vērtībām:
- 0:Nepazīstams
- 1: Primitīvs tips
- 2: ComplexType
- 3: EnumerationType
- 4:Kolekcija
- 5: EntityType
typeName :Virkne. Parametra tipa pilnībā kvalificēts nosaukums.

Atgrieztā vērtība

Ja tas ir veiksmīgs, atgriež solījuma objektu successCallback ar šādiem rekvizītiem:

Vārds Tips Apraksts
body(Novecojis) Objektu Atbildes struktūra.
headers Objektu Atbilžu galvenes.
ok Būla Norāda, vai pieprasījums bija veiksmīgs.
status Numurs Skaitliskā vērtība atbildes statusa kodā. Piemēram: 200
statusText String Atbildes statusa koda apraksts. Piemēram: OK
type(Novecojis) String Atbildes veids. Vērtības ir: tukša virkne (noklusējums), arraybuffer, blob, documentjson, un text.
url String Pieprasiet darbības, funkcijas vai CRUD pieprasījuma URL, ko nosūtījāt tīmekļa API galapunktam.
json Solījums Atzvanīšanas pārstāvja parametrs ir jebkura tipa (JSON objekts).
text Solījums Atzvanīšanas pārstāvja parametrs ir virkne.

Piemēri

Šos piemērus var atrast šādās sadaļās:

Piemērs Parāda
Darbības izpilde Kā izpildīt WinOpportunity darbību, lai atzīmētu iespēju kā uzvarētu.
Funkcijas izpilde Kā izpildīt WhoAmI, CalculateRollupField, RetrieveDuplicates, un InitializeFrom funkcijas un lasīt to atbildes.
Ieraksta izveide Kā izveidot konta ierakstu, izmantojot pieprasījuma objektu.
Ieraksta izgūšana Kā iegūt konta ieraksta nosaukumu, norādot tā ID un kolonnas, kuras atgriezt.
Ieraksta atjaunināšana Kā atjaunināt konta ieraksta nosaukumu, izmantojot pieprasījuma objektu.
Ieraksta dzēšana Kā dzēst konta ierakstu, norādot tā tabulu un ID.
Ieraksta saistīšana Kā piesaistīt kontu vairākiem kontaktiem, izmantojot kolekcijas vērtības navigācijas īpašumu.
Ieraksta atsaistīšana Kā noņemt saistību starp kontu un vienu kontaktu, izmantojot kolekcijas vērtības navigācijas īpašumu.

Padoms

Izmantojiet Dataverse REST Builder , lai ģenerētu JavaScript kodu, kas izmanto šo Xrm.WebApi.online.execute metodi.

Darbības izpildes piemērs

Tālāk sniegtajā piemērā parādīts, kā izpildīt Dynamics 365 for Sales risinājumā atrodamo WinOpportunity darbību. Pieprasījuma objekts tiek izveidots, balstoties uz darbības definīciju Unbound actions failā.

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
});

Izpildīt funkcijas piemēru

Šajā piemērā ir parādīts, kā izpildīt 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
});

Šis piemērs parāda, kā izpildīt 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
});

Šis piemērs parāda, kā izpildīt 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
});

Šis piemērs parāda, kā izpildīt 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
});

CRUD operāciju veikšana

Izveidojiet ieraksta piemēru

Šajā piemērā parādīts, kā veikt izveides operāciju.

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
});

Iegūt ieraksta piemēru

Šajā piemērā parādīts, kā veikt izgūšanas operāciju.

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
});

Atjaunināt ieraksta piemēru

Nākamais piemērs parāda, kā veikt atjaunināšanas operāciju.

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
});

Dzēst ieraksta piemēru

Šajā piemērā parādīts, kā veikt dzēšanas operāciju.

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
});

Pievienojiet ieraksta piemēru

Nākamais koda paraugs parāda, kā veikt asociēto operāciju ar kolekcijas vērtību navigācijas īpašībām (viens pret daudziem un daudzi-daudziem-daudziem attiecībām). Vienvērtību navigācijas īpašībām (daudzu pret vienu attiecībām, sauktām arī par meklēšanas kolonnām) var veikt atjaunināšanas operāciju, kā parādīts iepriekš, vai izmantot 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
});

Atdalīt ieraksta piemēru

Nākamais koda paraugs parāda, kā veikt disociācijas operāciju ar kolekcijas vērtību navigācijas īpašībām (viens pret daudziem un daudzi-uz-daudziem attiecībām). Vienvērtību navigācijas īpašībām (daudzu pret vienu attiecībām, sauktām arī par meklēšanas kolonnām) var veikt atjaunināšanas operāciju, kā parādīts iepriekš, vai izmantot Xrm.WebApi.updateRecord.

Piezīmes

Atšķirībā no asociētās operācijas, kuru var izmantot, lai vienā operācijā saistītu mērķa entitātes ierakstu ar vairākiem saistītiem entītiju ierakstiem, atsaistīšanas operācija katrā operācijā var atdalīt tikai vienu entitātes ierakstu no mērķa entītijas ieraksta.

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
});

Xrm.WebApi