استخدام واجهة API للويب لـ Microsoft Dataverse فِي أحد مكونات Power Apps.

  • 20 دقائق

السيناريو الشائع أثناء تطوير المكونات هو الحاجة إلى التفاعل مع البيانات الموجودة فِي Microsoft Dataverse للحل الخاص بك. يكشف Power Apps Component Framework عن ميزة واجهة API للويب لتحقيق هذا المطلب. يوضح هذا المثال كيفية تنفيذ عمليات CRUD المتنوعة باستخدام هذه الميزة.

ملاحظة

يتم دعم ميزة Web API فقط فِي التطبيقات التي تستند إلى النموذج.

تهيئة مشروع المكون الخاص بك

لتهيئة مشروع المكون الخاص بك، اتبع الخطوات التالية:

  1. ابدأ تشغيل Visual Studio Code.

  2. حدّد وحدة طرفية ثم حدّد وحدة طرفية جديدة.

  3. قم بتغيير الدليل إلى المجلد المصدر.

    cd source

  4. من الدليل المصدر، أنشئ دليلاً باسم TS-Web-API.

    md TS-Web-API

  5. شغّل الأمر التالي للتبديل إلى الدليل الجديد.

    cd TS-Web-API

  6. تهيئة المشروع عن طريق تشغيل الأمر التالي.

    pac pcf init --namespace SampleNamespace --name TSWebAPI --template field

  7. قم بتشغيل npm install لتحميل مكتبات مستقلة فِي المشروع.

    npm install

  8. افتح المشروع فِي Visual Studio Code عن طريق تشغيل الأمر التالي.

    code -a .

تنفيذ منطق مكون التعليمات البرمجية

لتنفيذ منطق مكون التعليمات البرمجية، اتبع الخطوات التالية:

  1. وسّع المجلد TSWebAPI وافتح الملف ControlManifest.Input.xml.

  2. استبدل البيان بأكمله بـ XML التالي.

    <?xml version="1.0" encoding="utf-8"?>
<manifest>
    <control namespace="SampleNamespace" constructor="TSWebAPI" version="1.0.0" display-name-key="TS_WebAPI_Display_Key" description-key="TS_WebAPI_Desc_Display_Key" control-type="standard">
        <property name="stringProperty" display-name-key="stringProperty_Display_Key" description-key="stringProperty_Desc_Key" of-type="SingleLine.Text" usage="bound" required="true" />
        <resources>
            <code path="index.ts" order="1" />
            <css path="css/TS_WebAPI.css" order="2" />
        </resources>
        <feature-usage>
            <uses-feature name="WebAPI" required="true" />
        </feature-usage>
    </control>
</manifest>

    تقوم بإضافة ملفات الدعم الموجودة فِي هذا البيان لاحقاً.

  3. افتح الملف Index.ts.

  4. فوق أسلوب المنشئ، قم بإدراج المتغيرات الخاصة التالية لدعم عرض المكون الخاص بك.

    // Reference to the control container HTMLDivElement
// This element contains all elements of our custom control example
private _container: HTMLDivElement;

// Reference to ComponentFramework Context object
private _context: ComponentFramework.Context<IInputs>;

// Flag if control view has been rendered
private _controlViewRendered: Boolean;

// References to button elements that are rendered by example custom control
private _createEntity1Button: HTMLButtonElement;
private _createEntity2Button: HTMLButtonElement;
private _createEntity3Button: HTMLButtonElement;
private _deleteRecordButton: HTMLButtonElement;
private _fetchXmlRefreshButton: HTMLButtonElement;
private _oDataRefreshButton: HTMLButtonElement;

// References to div elements that are rendered by the example custom control
private _odataStatusContainerDiv: HTMLDivElement;
private _resultContainerDiv: HTMLDivElement;

  5. أضف المتغيرات الثابتة الخاصة التالية فوق الدالة الإنشائية للإشارة إلى الكيان/الحقول التي ستتعامل معها فِي هذا المثال. إذا كنت ترغب فِي تجربة جداول أو أعمدة مختلفة، فيمكنك القيام بذلك من خلال تغيير القيم المعنية.

    // Name of entity to use for example Web API calls that are performed by this control
private static _entityName: string = "account";

// Required field on _entityName of type 'single line of text'
// Example Web API calls that are performed by the example custom control will set this field for new record creation examples
private static _requiredAttributeName: string = "name";

// Value that the _requiredAttributeName field will be set to for new created records
private static _requiredAttributeValue: string = "Web API Custom Control (Sample)";

// Name of currency field on _entityName to populate during record create
// Example Web API calls that are performed by the example custom control will set and read this field
private static _currencyAttributeName: string = "revenue";

// Friendly name of currency field (only used for control UI - no functional impact)
private static _currencyAttributeNameFriendlyName: string = "annual revenue";

  6. ضع المنطق التالي داخل أسلوب init.

    this._context = context;
this._controlViewRendered = false;
this._container = document.createElement("div");
this._container.classList.add("TSWebAPI_Container");
container.appendChild(this._container);

  7. أضف المنطق التالي إلى الأسلوب updateView.

    if (!this._controlViewRendered) {
    this._controlViewRendered = true;

    // Render Web API Examples
    this.renderCreateExample();
    this.renderDeleteExample();
    this.renderFetchXmlRetrieveMultipleExample();
    this.renderODataRetrieveMultipleExample();

    // Render result div to display output of Web API calls
    this.renderResultsDiv();}

  8. أضف التوابع المساعدة التالية لتصيير عناصر HTML فِي المكون الخاص بك بعد أسلوب الإهلاك.

    /**
* Helper method to create HTML button that is used for CreateRecord Web API Example
* @param buttonLabel : Label for button
* @param buttonId : ID for button
* @param buttonValue : Value of button (attribute of button)
* @param onClickHandler : onClick event handler to invoke for the button
*/
private createHTMLButtonElement(buttonLabel: string, buttonId: string, buttonValue: string | null, onClickHandler: (event?: any) => void): HTMLButtonElement {
    let button: HTMLButtonElement = document.createElement("button");
    button.innerHTML = buttonLabel;

    if (buttonValue) {
        button.setAttribute("buttonvalue", buttonValue);
    }

    button.id = buttonId;

    button.classList.add("SampleControl_WebAPI_ButtonClass");
    button.addEventListener("click", onClickHandler);
    return button;
}

/**
* Helper method to create HTML Div Element
* @param elementClassName : Class name of div element
* @param isHeader : True if 'header' div - adds extra class and post-fix to ID for header elements
* @param innerText : innerText of Div Element
*/
private createHTMLDivElement(elementClassName: string, isHeader: Boolean, innerText?: string): HTMLDivElement {
    let div: HTMLDivElement = document.createElement("div");

    if (isHeader) {
        div.classList.add("SampleControl_WebAPI_Header");
        elementClassName += "_header";
    }

    if (innerText) {
        div.innerText = innerText.toUpperCase();
    }

    div.classList.add(elementClassName);
    return div;
}

/** 
* Renders a 'result container' div element to inject the status of the example Web API calls 
*/
private renderResultsDiv() {
    // Render header label for result container
    let resultDivHeader: HTMLDivElement = this.createHTMLDivElement("result_container", true,
        "Result of last action");
    this._container.appendChild(resultDivHeader);

    // Div elements to populate with the result text
    this._resultContainerDiv = this.createHTMLDivElement("result_container", false, undefined);
    this._container.appendChild(this._resultContainerDiv);

    // Init the result container with a notification that the control was loaded
    this.updateResultContainerText("Web API sample custom control loaded");
}

/**
* Helper method to inject HTML into result container div
* @param statusHTML : HTML to inject into result container
*/
private updateResultContainerText(statusHTML: string): void {
    if (this._resultContainerDiv) {
        this._resultContainerDiv.innerHTML = statusHTML;
    }
}

/**
* Helper method to inject error string into result container div after failed Web API call
* @param errorResponse : error object from rejected promise
*/
private updateResultContainerTextWithErrorResponse(errorResponse: any): void {
    if (this._resultContainerDiv) {
        // Retrieve the error message from the errorResponse and inject into the result div
        let errorHTML: string = "Error with Web API call:";
        errorHTML += "<br />"
        errorHTML += errorResponse.message;
        this._resultContainerDiv.innerHTML = errorHTML;
    }
}

/**
* Helper method to generate Label for Create Buttons
* @param entityNumber : value to set _currencyAttributeNameFriendlyName field to for this button
*/
private getCreateRecordButtonLabel(entityNumber: string): string {
    return "Create record with " + TSWebAPI._currencyAttributeNameFriendlyName + " of " + entityNumber;
}

/**
* Helper method to generate ID for Create button
* @param entityNumber : value to set _currencyAttributeNameFriendlyName field to for this button
*/
private getCreateButtonId(entityNumber: string): string {
    return "create_button_" + entityNumber;
}

  9. قم بإضافة معالجات الحدث onClick التالية لتشغيل عمليات CRUD المتعددة بعد أساليب المساعد.

    /**
* Event Handler for onClick of create record button
* @param event : click event
*/
private createButtonOnClickHandler(event: Event): void {
    // Retrieve the value to set the currency field to from the button's attribute
    let currencyAttributeValue: Number = parseInt(
        (event.srcElement! as Element)!.attributes.getNamedItem("buttonvalue")!.value
    );

    // Generate unique record name by appending timestamp to _requiredAttributeValue
    let recordName: string = TSWebAPI._requiredAttributeValue + "_" + Date.now();

    // Set the values for the attributes we want to set on the new record
    // If you want to set additional attributes on the new record, add to data dictionary as key/value pair
    var data: any = {};
    data[TSWebAPI._requiredAttributeName] = recordName;
    data[TSWebAPI._currencyAttributeName] = currencyAttributeValue;

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API to create the new record
    this._context.webAPI.createRecord(TSWebAPI._entityName, data).then(
        function (response: ComponentFramework.LookupValue) {
            // Callback method for successful creation of new record

            // Get the ID of the new record created
            let id: string = response.id;

            // Generate HTML to inject into the result div to showcase the fields and values of the new record that is created
            let resultHtml: string = "Created new " + TSWebAPI._entityName + " record with below values:"
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += "id: " + id;
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += TSWebAPI._requiredAttributeName + ": " + recordName;
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += TSWebAPI._currencyAttributeName + ": " + currencyAttributeValue;

            thisRef.updateResultContainerText(resultHtml);
        },
        function (errorResponse: any) {
            // Error handling code here - record failed to be created
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

/**
* Event Handler for onClick of delete record button
* @param event : click event
*/
private deleteButtonOnClickHandler(): void {
    // Invoke a lookup dialog to allow the user to select an existing record of type _entityName to delete
    var lookUpOptions: any =
    {
        entityTypes: [TSWebAPI._entityName]
    };

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    var lookUpPromise: any = this._context.utils.lookupObjects(lookUpOptions);

    lookUpPromise.then(
        // Callback method - invoked after user has selected an item from the lookup dialog
        // Data parameter is the item selected in the lookup dialog
        (data: ComponentFramework.EntityReference[]) => {
            if (data && data[0]) {
                // Get the ID and entityType of the record that was selected by the lookup
                let id: string = data[0].id.guid;
                let entityType: string = data[0].etn!;

                // Invoke the deleteRecord method of the WebAPI to delete the selected record
                this._context.webAPI.deleteRecord(entityType, id).then(
                    function (response: ComponentFramework.LookupValue) {
                        // Record was deleted successfully
                        let responseId: string = response.id;
                        let responseEntityType: string = response.name!;

                        // Generate HTML to inject into the result div to showcase the deleted record 
                        thisRef.updateResultContainerText("Deleted " + responseEntityType + " record with ID: " + responseId);
                    },
                    function (errorResponse: any) {
                        // Error handling code here
                        thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
                    }
                );
            }
        },
        (error: any) => {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(error);
        }
    );
}

/**
* Event Handler for onClick of calculate average value button
* @param event : click event
*/
private calculateAverageButtonOnClickHandler(): void {
    // Build FetchXML to retrieve the average value of _currencyAttributeName field for all _entityName records
    // Add a filter to only aggregate on records that have _currencyAttributeName not set to null
    let fetchXML: string = "<fetch distinct='false' mapping='logical' aggregate='true'>";
    fetchXML += "<entity name='" + TSWebAPI._entityName + "'>";
    fetchXML += "<attribute name='" + TSWebAPI._currencyAttributeName + "' aggregate='avg' alias='average_val' />";
    fetchXML += "<filter>";
    fetchXML += "<condition attribute='" + TSWebAPI._currencyAttributeName + "' operator='not-null' />";
    fetchXML += "</filter>";
    fetchXML += "</entity>";
    fetchXML += "</fetch>";

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API RetrieveMultipleRecords method to calculate the aggregate value
    this._context.webAPI.retrieveMultipleRecords(TSWebAPI._entityName, "?fetchXml=" + fetchXML).then(
        function (response: ComponentFramework.WebApi.RetrieveMultipleResponse) {
            // Retrieve multiple completed successfully -- retrieve the averageValue 
            let averageVal: Number = response.entities[0].average_val;

            // Generate HTML to inject into the result div to showcase the result of the RetrieveMultiple Web API call
            let resultHTML: string = "Average value of " + TSWebAPI._currencyAttributeNameFriendlyName + " attribute for all " + TSWebAPI._entityName + " records: " + averageVal;
            thisRef.updateResultContainerText(resultHTML);
        },
        function (errorResponse: any) {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

/**
* Event Handler for onClick of calculate record count button
* @param event : click event
*/
private refreshRecordCountButtonOnClickHandler(): void {
    // Generate OData query string to retrieve the _currencyAttributeName field for all _entityName records
    // Add a filter to only retrieve records with _requiredAttributeName field which contains _requiredAttributeValue
    let queryString: string = "?$select=" + TSWebAPI._currencyAttributeName + "&$filter=contains(" + TSWebAPI._requiredAttributeName +
        ",'" + TSWebAPI._requiredAttributeValue + "')";

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API Retrieve Multiple call
    this._context.webAPI.retrieveMultipleRecords(TSWebAPI._entityName, queryString).then(
        function (response: any) {
            // Retrieve Multiple Web API call completed successfully
            let count1: number = 0;
            let count2: number = 0;
            let count3: number = 0;

            // Loop through each returned record
            for (let entity of response.entities) {
                // Retrieve the value of _currencyAttributeName field
                let value: Number = entity[TSWebAPI._currencyAttributeName];

                // Check the value of _currencyAttributeName field and increment the correct counter
                if (value == 100) {
                    count1++;
                }
                else if (value == 200) {
                    count2++;
                }
                else if (value == 300) {
                    count3++;
                }
            }

            // Generate HTML to inject into the fetch xml status div to showcase the results of the OData retrieve example
            let innerHtml: string = "Use above buttons to create or delete a record to see count update";
            innerHtml += "<br />";
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 100: " + count1;
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 200: " + count2;
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 300: " + count3;

            // Inject the HTML into the fetch xml status div
            if (thisRef._odataStatusContainerDiv) {
                thisRef._odataStatusContainerDiv.innerHTML = innerHtml;
            }

            // Inject a success message into the result div
            thisRef.updateResultContainerText("Record count refreshed");
        },
        function (errorResponse: any) {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

  10. قم بإضافة أساليب المساعدة التالية لتقديم نتائج عمليات CRUD الخاصة بك داخل المكون الخاص بك بعد أساليب معالج الأحداث.

    /**
* Renders example use of CreateRecord Web API
*/
private renderCreateExample() {
    // Create header label for Web API sample
    let headerDiv: HTMLDivElement = this.createHTMLDivElement("create_container", true, "Click to create "
        + TSWebAPI._entityName + " record");
    this._container.appendChild(headerDiv);

    // Create button 1 to create a record with the revenue field set to 100
    let value1: string = "100";
    this._createEntity1Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value1),
        this.getCreateButtonId(value1),
        value1,
        this.createButtonOnClickHandler.bind(this));

    // Create button 2 to create a record with the revenue field set to 200
    let value2: string = "200";
    this._createEntity2Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value2),
        this.getCreateButtonId(value2),
        value2,
        this.createButtonOnClickHandler.bind(this));

    // Create button 3 to create a record with the revenue field set to 300
    let value3: string = "300";
    this._createEntity3Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value3),
        this.getCreateButtonId(value3),
        value3,
        this.createButtonOnClickHandler.bind(this));

    // Append all button HTML elements to custom control container div
    this._container.appendChild(this._createEntity1Button);
    this._container.appendChild(this._createEntity2Button);
    this._container.appendChild(this._createEntity3Button);
}

/** 
* Renders example use of DeleteRecord Web API
*/
private renderDeleteExample(): void {
    // Create header label for Web API sample
    let headerDiv: HTMLDivElement = this.createHTMLDivElement("delete_container", true, "Click to delete " + TSWebAPI._entityName + " record");

    // Render button to invoke DeleteRecord Web API call
    this._deleteRecordButton = this.createHTMLButtonElement(
        "Select record to delete",
        "delete_button",
        null,
        this.deleteButtonOnClickHandler.bind(this));

    // Append elements to custom control container div
    this._container.appendChild(headerDiv);
    this._container.appendChild(this._deleteRecordButton);
}

/** 
* Renders example use of RetrieveMultiple Web API with OData
*/
private renderODataRetrieveMultipleExample(): void {
    let containerClassName: string = "odata_status_container";

    // Create header label for Web API sample
    let statusDivHeader: HTMLDivElement = this.createHTMLDivElement(containerClassName, true, "Click to refresh record count");
    this._odataStatusContainerDiv = this.createHTMLDivElement(containerClassName, false, undefined);

    // Create button to invoke OData RetrieveMultiple Example
    this._fetchXmlRefreshButton = this.createHTMLButtonElement(
        "Refresh record count",
        "odata_refresh",
        null,
        this.refreshRecordCountButtonOnClickHandler.bind(this));

    // Append HTML elements to custom control container div
    this._container.appendChild(statusDivHeader);
    this._container.appendChild(this._odataStatusContainerDiv);
    this._container.appendChild(this._fetchXmlRefreshButton);
}

/** 
* Renders example use of RetrieveMultiple Web API with Fetch XML
*/
private renderFetchXmlRetrieveMultipleExample(): void {
    let containerName: string = "fetchxml_status_container";

    // Create header label for Web API sample
    let statusDivHeader: HTMLDivElement = this.createHTMLDivElement(containerName, true,
        "Click to calculate average value of " + TSWebAPI._currencyAttributeNameFriendlyName);
    let statusDiv: HTMLDivElement = this.createHTMLDivElement(containerName, false, undefined);

    // Create button to invoke Fetch XML RetrieveMultiple Web API example
    this._oDataRefreshButton = this.createHTMLButtonElement(
        "Calculate average value of " + TSWebAPI._currencyAttributeNameFriendlyName,
        "odata_refresh",
        null,
        this.calculateAverageButtonOnClickHandler.bind(this));

    // Append HTML Elements to custom control container div
    this._container.appendChild(statusDivHeader);
    this._container.appendChild(statusDiv);
    this._container.appendChild(this._oDataRefreshButton);
}

  11. بعد إجراء التحديثات، يجب أن تبدو الفئة المكتملة مماثلة للمثال التالي.

    import { IInputs, IOutputs } from "./generated/ManifestTypes";

export class TSWebAPI implements ComponentFramework.StandardControl<IInputs, IOutputs> {

// Reference to the control container HTMLDivElement
// This element contains all elements of our custom control example
private _container: HTMLDivElement;

// Reference to ComponentFramework Context object
private _context: ComponentFramework.Context<IInputs>;

// Flag if control view has been rendered
private _controlViewRendered: Boolean;

// References to button elements that are rendered by example custom control
private _createEntity1Button: HTMLButtonElement;
private _createEntity2Button: HTMLButtonElement;
private _createEntity3Button: HTMLButtonElement;
private _deleteRecordButton: HTMLButtonElement;
private _fetchXmlRefreshButton: HTMLButtonElement;
private _oDataRefreshButton: HTMLButtonElement;

// References to div elements that are rendered by the example custom control
private _odataStatusContainerDiv: HTMLDivElement;
private _resultContainerDiv: HTMLDivElement;

// Name of entity to use for example Web API calls that are performed by this control
private static _entityName: string = "account";

// Required field on _entityName of type 'single line of text'
// Example Web API calls that are performed by the example custom control will set this field for new record creation examples
private static _requiredAttributeName: string = "name";

// Value that the _requiredAttributeName field will be set to for new created records
private static _requiredAttributeValue: string = "Web API Custom Control (Sample)";

// Name of currency field on _entityName to populate during record create
// Example Web API calls that are performed by the example custom control will set and read this field
private static _currencyAttributeName: string = "revenue";

// Friendly name of currency field (only used for control UI - no functional impact)
private static _currencyAttributeNameFriendlyName: string = "annual revenue";

/**
 * Empty constructor.
 */
constructor() {

}

/**
 * Used to initialize the control instance. Controls can kick off remote server calls and other initialization actions here.
 * Data-set values are not initialized here, use updateView.
 * @param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to property names defined in the manifest, as well as utility functions.
 * @param notifyOutputChanged A callback method to alert the framework that the control has new outputs ready to be retrieved asynchronously.
 * @param state A piece of data that persists in one session for a single user. Can be set at any point in a controls life cycle by calling 'setControlState' in the Mode interface.
 * @param container If a control is marked control-type='standard', it will receive an empty div element within which it can render its content.
 */
public init(context: ComponentFramework.Context<IInputs>, notifyOutputChanged: () => void, state: ComponentFramework.Dictionary, container: HTMLDivElement): void {
    this._context = context;
    this._controlViewRendered = false;
    this._container = document.createElement("div");
    this._container.classList.add("TSWebAPI_Container");
    container.appendChild(this._container);
}


/**
 * Called when any value in the property bag has changed. This includes field values, data-sets, global values such as container height and width, offline status, control metadata values such as label, visible, etc.
 * @param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to names defined in the manifest, as well as utility functions
 */
public updateView(context: ComponentFramework.Context<IInputs>): void {
    if (!this._controlViewRendered) {
        this._controlViewRendered = true;

        // Render Web API Examples
        this.renderCreateExample();
        this.renderDeleteExample();
        this.renderFetchXmlRetrieveMultipleExample();
        this.renderODataRetrieveMultipleExample();

        // Render result div to display output of Web API calls
        this.renderResultsDiv();}
}

/**
 * It is called by the framework prior to a control receiving new data.
 * @returns an object based on nomenclature defined in manifest, expecting object[s] for property marked as “bound” or “output”
 */
public getOutputs(): IOutputs {
    return {};
}

/**
 * Called when the control is to be removed from the DOM tree. Controls should use this call for cleanup.
 * i.e. cancelling any pending remote calls, removing listeners, etc.
 */
public destroy(): void {
    // Add code to cleanup control if necessary
}

/**
 * Helper method to create HTML button that is used for CreateRecord Web API Example
 * @param buttonLabel : Label for button
 * @param buttonId : ID for button
 * @param buttonValue : Value of button (attribute of button)
 * @param onClickHandler : onClick event handler to invoke for the button
 */
 private createHTMLButtonElement(buttonLabel: string, buttonId: string, buttonValue: string | null, onClickHandler: (event?: any) => void): HTMLButtonElement {
    let button: HTMLButtonElement = document.createElement("button");
    button.innerHTML = buttonLabel;

    if (buttonValue) {
        button.setAttribute("buttonvalue", buttonValue);
    }

    button.id = buttonId;

    button.classList.add("SampleControl_WebAPI_ButtonClass");
    button.addEventListener("click", onClickHandler);
    return button;
}

/**
 * Helper method to create HTML Div Element
 * @param elementClassName : Class name of div element
 * @param isHeader : True if 'header' div - adds extra class and post-fix to ID for header elements
 * @param innerText : innerText of Div Element
 */
private createHTMLDivElement(elementClassName: string, isHeader: Boolean, innerText?: string): HTMLDivElement {
    let div: HTMLDivElement = document.createElement("div");

    if (isHeader) {
        div.classList.add("SampleControl_WebAPI_Header");
        elementClassName += "_header";
    }

    if (innerText) {
        div.innerText = innerText.toUpperCase();
    }

    div.classList.add(elementClassName);
    return div;
}

/** 
* Renders a 'result container' div element to inject the status of the example Web API calls 
*/
private renderResultsDiv() {
    // Render header label for result container
    let resultDivHeader: HTMLDivElement = this.createHTMLDivElement("result_container", true,
        "Result of last action");
    this._container.appendChild(resultDivHeader);

    // Div elements to populate with the result text
    this._resultContainerDiv = this.createHTMLDivElement("result_container", false, undefined);
    this._container.appendChild(this._resultContainerDiv);

    // Init the result container with a notification that the control was loaded
    this.updateResultContainerText("Web API sample custom control loaded");
}

/**
* Helper method to inject HTML into result container div
* @param statusHTML : HTML to inject into result container
*/
private updateResultContainerText(statusHTML: string): void {
    if (this._resultContainerDiv) {
        this._resultContainerDiv.innerHTML = statusHTML;
    }
}

/**
 * Helper method to inject error string into result container div after failed Web API call
 * @param errorResponse : error object from rejected promise
 */
private updateResultContainerTextWithErrorResponse(errorResponse: any): void {
    if (this._resultContainerDiv) {
        // Retrieve the error message from the errorResponse and inject into the result div
        let errorHTML: string = "Error with Web API call:";
        errorHTML += "<br />"
        errorHTML += errorResponse.message;
        this._resultContainerDiv.innerHTML = errorHTML;
    }
}

/**
* Helper method to generate Label for Create Buttons
* @param entityNumber : value to set _currencyAttributeNameFriendlyName field to for this button
*/
private getCreateRecordButtonLabel(entityNumber: string): string {
    return "Create record with " + TSWebAPI._currencyAttributeNameFriendlyName + " of " + entityNumber;
}

/**
* Helper method to generate ID for Create button
* @param entityNumber : value to set _currencyAttributeNameFriendlyName field to for this button
*/
private getCreateButtonId(entityNumber: string): string {
    return "create_button_" + entityNumber;
}

/**
* Event Handler for onClick of create record button
* @param event : click event
*/
private createButtonOnClickHandler(event: Event): void {
    // Retrieve the value to set the currency field to from the button's attribute
    let currencyAttributeValue: Number = parseInt(
        (event.srcElement! as Element)!.attributes.getNamedItem("buttonvalue")!.value
    );

    // Generate unique record name by appending timestamp to _requiredAttributeValue
    let recordName: string = TSWebAPI._requiredAttributeValue + "_" + Date.now();

    // Set the values for the attributes we want to set on the new record
    // If you want to set additional attributes on the new record, add to data dictionary as key/value pair
    var data: any = {};
    data[TSWebAPI._requiredAttributeName] = recordName;
    data[TSWebAPI._currencyAttributeName] = currencyAttributeValue;

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API to create the new record
    this._context.webAPI.createRecord(TSWebAPI._entityName, data).then(
        function (response: ComponentFramework.LookupValue) {
            // Callback method for successful creation of new record

            // Get the ID of the new record created
            let id: string = response.id;

            // Generate HTML to inject into the result div to showcase the fields and values of the new record that is created
            let resultHtml: string = "Created new " + TSWebAPI._entityName + " record with below values:"
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += "id: " + id;
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += TSWebAPI._requiredAttributeName + ": " + recordName;
            resultHtml += "<br />";
            resultHtml += "<br />";
            resultHtml += TSWebAPI._currencyAttributeName + ": " + currencyAttributeValue;

            thisRef.updateResultContainerText(resultHtml);
        },
        function (errorResponse: any) {
            // Error handling code here - record failed to be created
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

/**
* Event Handler for onClick of delete record button
* @param event : click event
*/
private deleteButtonOnClickHandler(): void {
    // Invoke a lookup dialog to allow the user to select an existing record of type _entityName to delete
    var lookUpOptions: any =
    {
        entityTypes: [TSWebAPI._entityName]
    };

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    var lookUpPromise: any = this._context.utils.lookupObjects(lookUpOptions);

    lookUpPromise.then(
        // Callback method - invoked after user has selected an item from the lookup dialog
        // Data parameter is the item selected in the lookup dialog
        (data: ComponentFramework.EntityReference[]) => {
            if (data && data[0]) {
                // Get the ID and entityType of the record that was selected by the lookup
                let id: string = data[0].id.guid;
                let entityType: string = data[0].etn!;

                // Invoke the deleteRecord method of the WebAPI to delete the selected record
                this._context.webAPI.deleteRecord(entityType, id).then(
                    function (response: ComponentFramework.LookupValue) {
                        // Record was deleted successfully
                        let responseId: string = response.id;
                        let responseEntityType: string = response.name!;

                        // Generate HTML to inject into the result div to showcase the deleted record 
                        thisRef.updateResultContainerText("Deleted " + responseEntityType + " record with ID: " + responseId);
                    },
                    function (errorResponse: any) {
                        // Error handling code here
                        thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
                    }
                );
            }
        },
        (error: any) => {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(error);
        }
    );
}

/**
* Event Handler for onClick of calculate average value button
* @param event : click event
*/
private calculateAverageButtonOnClickHandler(): void {
    // Build FetchXML to retrieve the average value of _currencyAttributeName field for all _entityName records
    // Add a filter to only aggregate on records that have _currencyAttributeName not set to null
    let fetchXML: string = "<fetch distinct='false' mapping='logical' aggregate='true'>";
    fetchXML += "<entity name='" + TSWebAPI._entityName + "'>";
    fetchXML += "<attribute name='" + TSWebAPI._currencyAttributeName + "' aggregate='avg' alias='average_val' />";
    fetchXML += "<filter>";
    fetchXML += "<condition attribute='" + TSWebAPI._currencyAttributeName + "' operator='not-null' />";
    fetchXML += "</filter>";
    fetchXML += "</entity>";
    fetchXML += "</fetch>";

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API RetrieveMultipleRecords method to calculate the aggregate value
    this._context.webAPI.retrieveMultipleRecords(TSWebAPI._entityName, "?fetchXml=" + fetchXML).then(
        function (response: ComponentFramework.WebApi.RetrieveMultipleResponse) {
            // Retrieve multiple completed successfully -- retrieve the averageValue 
            let averageVal: Number = response.entities[0].average_val;

            // Generate HTML to inject into the result div to showcase the result of the RetrieveMultiple Web API call
            let resultHTML: string = "Average value of " + TSWebAPI._currencyAttributeNameFriendlyName + " attribute for all " + TSWebAPI._entityName + " records: " + averageVal;
            thisRef.updateResultContainerText(resultHTML);
        },
        function (errorResponse: any) {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

/**
* Event Handler for onClick of calculate record count button
* @param event : click event
*/
private refreshRecordCountButtonOnClickHandler(): void {
    // Generate OData query string to retrieve the _currencyAttributeName field for all _entityName records
    // Add a filter to only retrieve records with _requiredAttributeName field which contains _requiredAttributeValue
    let queryString: string = "?$select=" + TSWebAPI._currencyAttributeName + "&$filter=contains(" + TSWebAPI._requiredAttributeName +
        ",'" + TSWebAPI._requiredAttributeValue + "')";

    // store reference to 'this' so it can be used in the callback method
    var thisRef = this;

    // Invoke the Web API Retrieve Multiple call
    this._context.webAPI.retrieveMultipleRecords(TSWebAPI._entityName, queryString).then()
        function (response: any) {
            // Retrieve Multiple Web API call completed successfully
            let count1: number = 0;
            let count2: number = 0;
            let count3: number = 0;

            // Loop through each returned record
            for (let entity of response.entities) {
                // Retrieve the value of _currencyAttributeName field
                let value: Number = entity[TSWebAPI._currencyAttributeName];

                // Check the value of _currencyAttributeName field and increment the correct counter
                if (value == 100) {
                    count1++;
                }
                else if (value == 200) {
                    count2++;
                }
                else if (value == 300) {
                    count3++;
                }
            }

            // Generate HTML to inject into the fetch xml status div to showcase the results of the OData retrieve example
            let innerHtml: string = "Use above buttons to create or delete a record to see count update";
            innerHtml += "<br />";
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 100: " + count1;
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 200: " + count2;
            innerHtml += "<br />";
            innerHtml += "Count of " + TSWebAPI._entityName + " records with " + TSWebAPI._currencyAttributeName + " of 300: " + count3;

            // Inject the HTML into the fetch xml status div
            if (thisRef._odataStatusContainerDiv) {
                thisRef._odataStatusContainerDiv.innerHTML = innerHtml;
            }

            // Inject a success message into the result div
            thisRef.updateResultContainerText("Record count refreshed");
        },
        function (errorResponse: any) {
            // Error handling code here
            thisRef.updateResultContainerTextWithErrorResponse(errorResponse);
        }
    );
}

/** 
* Renders example use of CreateRecord Web API
*/
private renderCreateExample() {
    // Create header label for Web API sample
    let headerDiv: HTMLDivElement = this.createHTMLDivElement("create_container", true, "Click to create "
        + TSWebAPI._entityName + " record");
    this._container.appendChild(headerDiv);

    // Create button 1 to create a record with the revenue field set to 100
    let value1: string = "100";
    this._createEntity1Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value1),
        this.getCreateButtonId(value1),
        value1,
        this.createButtonOnClickHandler.bind(this));

    // Create button 2 to create a record with the revenue field set to 200
    let value2: string = "200";
    this._createEntity2Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value2),
        this.getCreateButtonId(value2),
        value2,
        this.createButtonOnClickHandler.bind(this));

    // Create button 3 to create a record with the revenue field set to 300
    let value3: string = "300";
    this._createEntity3Button = this.createHTMLButtonElement(
        this.getCreateRecordButtonLabel(value3),
        this.getCreateButtonId(value3),
        value3,
        this.createButtonOnClickHandler.bind(this));

    // Append all button HTML elements to custom control container div
    this._container.appendChild(this._createEntity1Button);
    this._container.appendChild(this._createEntity2Button);
    this._container.appendChild(this._createEntity3Button);
}

/** 
* Renders example use of DeleteRecord Web API
*/
private renderDeleteExample(): void {
    // Create header label for Web API sample
    let headerDiv: HTMLDivElement = this.createHTMLDivElement("delete_container", true, "Click to delete " + TSWebAPI._entityName + " record");

    // Render button to invoke DeleteRecord Web API call
    this._deleteRecordButton = this.createHTMLButtonElement(
        "Select record to delete",
        "delete_button",
        null,
        this.deleteButtonOnClickHandler.bind(this));

    // Append elements to custom control container div
    this._container.appendChild(headerDiv);
    this._container.appendChild(this._deleteRecordButton);
}

/** 
* Renders example use of RetrieveMultiple Web API with OData
*/
private renderODataRetrieveMultipleExample(): void {
    let containerClassName: string = "odata_status_container";

    // Create header label for Web API sample
    let statusDivHeader: HTMLDivElement = this.createHTMLDivElement(containerClassName, true, "Click to refresh record count");
    this._odataStatusContainerDiv = this.createHTMLDivElement(containerClassName, false, undefined);

    // Create button to invoke OData RetrieveMultiple Example
    this._fetchXmlRefreshButton = this.createHTMLButtonElement(
        "Refresh record count",
        "odata_refresh",
        null,
        this.refreshRecordCountButtonOnClickHandler.bind(this));

    // Append HTML elements to custom control container div
    this._container.appendChild(statusDivHeader);
    this._container.appendChild(this._odataStatusContainerDiv);
    this._container.appendChild(this._fetchXmlRefreshButton);
}

/** 
* Renders example use of RetrieveMultiple Web API with Fetch XML
*/
private renderFetchXmlRetrieveMultipleExample(): void {
    let containerName: string = "fetchxml_status_container";

    // Create header label for Web API sample
    let statusDivHeader: HTMLDivElement = this.createHTMLDivElement(containerName, true,
        "Click to calculate average value of " + TSWebAPI._currencyAttributeNameFriendlyName);
    let statusDiv: HTMLDivElement = this.createHTMLDivElement(containerName, false, undefined);

    // Create button to invoke Fetch XML RetrieveMultiple Web API example
    this._oDataRefreshButton = this.createHTMLButtonElement(
        "Calculate average value of " + TSWebAPI._currencyAttributeNameFriendlyName,
        "odata_refresh",
        null,
        this.calculateAverageButtonOnClickHandler.bind(this));

    // Append HTML Elements to custom control container div
    this._container.appendChild(statusDivHeader);
    this._container.appendChild(statusDiv);
    this._container.appendChild(this._oDataRefreshButton);
}

إضافة تصميم إلى مكون التعليمات البرمجية‬

لإضافة تصميم إلى مكون التعليمات البرمجية‬، اتبع الخطوات الآتية:

  1. أنشئ مجلداً فرعياً جديداً باسم css تحت المجلد TSWebAPI.

  2. أنشئ ملف TS_WebAPI.css جديدًا داخل المجلد الفرعي CSS.

  3. أضِف محتوى التصميم التالي إلى ملف TS_WebAPI.css:

    .SampleNamespace\.TSWebAPI
{
    font-family: 'SegoeUI-Semibold', 'Segoe UI Semibold', 'Segoe UI Regular', 'Segoe UI';
    color: #1160B7;
}

.SampleNamespace\.TSWebAPI .TSWebAPI_Container
{
    overflow-x: auto;
}

.SampleNamespace\.TSWebAPI .SampleControl_WebAPI_Header
{
    color: rgb(51, 51, 51);
    font-size: 1rem;
    padding-top: 20px;
}

.SampleNamespace\.TSWebAPI .result_container
{
    padding-bottom: 20px;
}

.SampleNamespace\.TSWebAPI .SampleControl_WebAPI_ButtonClass
{
    text-decoration: none;
    display: inline-block;
    font-size: 14px;
    cursor: pointer;
    color: #1160B7;
    background-color: #FFFFFF;
    border: 1px solid black;
    padding: 5px;
    text-align: center;
    min-width: 300px;
    margin-top: 10px;
    margin-bottom: 5px;
    display: block;
}

  4. حدّد ملف وحفظ كل تغييراتك.

إنشاء المكون وتشغيله

لإنشاء المكون وتشغيله، اتبع الخطوات التالية:

  1. أنشئ حلك عن طريق تشغيل الأمر التالي.

    npm run build

  2. وبناء على الإنشاء الناجح، يمكنك اختبار مكون واجهة برمجة التطبيقات (API) للتنسيق الجديد عن طريق تشغيل npm start.

    npm start

  3. أغلق نافذة متصفح مفعّل الاختبار.

  4. عد إلى الوحدة الطرفية وأوقف المراقب عن طريق الضغط على [CONTROL] + C.

  5. اكتب Y ثم اضغط على [ENTER].

لاختبار وظيفة واجهة API للويب، تحتاج إلى نشر واستضافة المكون فِي بيئة Microsoft Power Platform. لمزيد من المعلومات حول كيفية نشر مكونات التعليمات البرمجية، راجع "إنشاء حزمة حل مكون التعليمات البرمجية" فِي الوحدة النمطية إنشاء مكون Power Apps.

لمزيد من المعلومات، راجع تنفيذ مكون Web API.