cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
ManishJain
Solution Sage
Solution Sage

How to call custom actions using PCF

How do I make calls to custom actions from PCF ? Any suggestions , please help.

 

Thanks

18 REPLIES 18
Anonymous
Not applicable

I'm unable to call a custom action following the ms documentation on using custom actions and this thread. The following is my query I append to the url:

 

const query = `/api/data/v9.0/incidents(${this._entityId})/Microsoft.Dynamics.CRM.my_CustomAction`;

 

 

I'm now getting this error:

{"error":{"code":"","message":"No HTTP resource was found that matches the request URI 'https://XXX.crm4.dynamics.com/api/data/v9.0/incidents(1234567890)/Microsoft.Dynamics.CRM.my_CustomAction'."}}

What am I missing?

 

 

let response = await fetch(query, {
			method: 'post',
			headers: headers,
			body: body
		});

 

 

HI @Anonymous ,

 

If you are able to make custom action call from D365 , I would suggest solution by @ben-thompson , I used the same xmlhttp call as I was not sure about Xrm.Webapi being suppported for custom action call.

 

Thanks

Daniel_Bergsten
New Member

This is how I implemented PCF call to custom action / Custom API:

        //execute custom api action
        /*
        <Action Name="sos_customapi_getcontactinfo">
        <Parameter Name="ContactID" Type="Edm.Guid" Nullable="false"/>
        <ReturnType Type="mscrm.sos_customapi_getcontactinfoResponse" Nullable="false"/>
        </Action>
        */
        // Execute request
        var apiRequest = new class {

            ContactID = {
                guid: "934fd982-988c-eb11-b1ac-0022489bcf55"
            };

            getMetadata(): any {
                return {
                    parameterTypes: {

                        ContactID: {
                            typeName: "Edm.Guid",
                            structuralProperty: 1
                        }
                    },
                    operationType: 0,
                    operationName: "sos_customapi_getcontactinfo"
                };
            }
        }();

        // <li-user uid="7429" login="TS"></li-user>-ignore
        this.context.webAPI.execute(apiRequest).then(
            function success(response: any) {
                console.log(response);
            },
            function (errorResponse: any) {
                // Error handling code here
                console.log(errorResponse);
            }
        );

A small improvement of the code above. This example uses casting to enable calling the execute method:

 //execute custom api action
        /*
        <Action Name="sos_customapi_getcontactinfo">
        <Parameter Name="ContactID" Type="Edm.Guid" Nullable="false"/>
        <ReturnType Type="mscrm.sos_customapi_getcontactinfoResponse" Nullable="false"/>
        </Action>
        */
        // Execute request
        var apiRequest = new class {

            ContactID = {
                guid: "934fd982-988c-eb11-b1ac-0022489bcf55"
            };

            getMetadata(): any {
                return {
                    parameterTypes: {

                        ContactID: {
                            typeName: "Edm.Guid",
                            structuralProperty: 1
                        }
                    },
                    operationType: 0,
                    operationName: "sos_customapi_getcontactinfo"
                };
            }
        }();

        var anyWebAPI = <any>this.context.webAPI;
        anyWebAPI.execute(apiRequest).then(
            function success(response: any) {
                console.log(response);
                console.log(response.json());
            },
            function (errorResponse: any) {
                // Error handling code here
                console.log(errorResponse);
            }
        );
Mab
Regular Visitor

I am quite new with PCF controls and had a task to call a Custom API from PCF control which is built using React, Typescript and Fluent UI. @ScottDurow is right webAPI (which is pulled from context (ComponentFramework.Context<IInputs>) does have execute method in it.

This method is not part of Typescript but if you debug the control you should be able to see it on the WebAPI.

then I used "//@ts-ignore" to ignore typescript as you can see below. It works like a charm

 var apiRequest = new class {
                AreaCode = inputText;
            
                getMetadata(): any {
                        return {
                        parameterTypes: {
                            "AreaCode ": {
                                "typeName": "Edm.String",
                                "structuralProperty": 1
                            }
                        },
                        operationType: 0,
                        operationName: "customapiname",
                    };
                    }
            }();

//@ts-ignore
this.context.webAPI.execute(apiRequest).then(
            function success(response: any) {
                console.log(response);
                console.log(response.json());
            },
            function (errorResponse: any) {
                // Error handling code here
                console.log(errorResponse);
            }
        );

 

skoofy5
Continued Contributor
Continued Contributor

I haven't checked it, but I feel like the xhr wouldn't be difficult - something like this:

 

function callCustomAction(newAreaCode: string, customapiname:string) {

  var data = {
    "AreaCode": newAreaCode
  };

  const url = "/api/data/v9.2/" + customapiname;
  var req = new XMLHttpRequest();
  req.open("POST", url, true);
  req.setRequestHeader("Accept", "application/json");
  req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
  req.setRequestHeader("OData-MaxVersion", "4.0");
  req.setRequestHeader("OData-Version", "4.0");
  req.onreadystatechange = function() {
    if (this.readyState == 4) {
      req.onreadystatechange = null;
      if (this.status == 200) {
        //callback or processing goes here
      }
    }
  };
req.send(JSON.stringify(data));
}

 

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

I still prefer the context.webApi.execute, since the xhr won't work offline.

Anothe problem is setting up the url for the webAPI xhr request. At least the version from the url will change some time. 
Integrated ways are the best.

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."


@DianaBirkelbach wrote:

I still prefer the context.webApi.execute, since the xhr won't work offline.

Anothe problem is setting up the url for the webAPI xhr request. At least the version from the url will change some time. 
Integrated ways are the best.


Integrated is definitely the way to go, but only when they're documented or there has been communication that things are stable enough to start implementing. Unfortunately this is all I've seen, but would be really happy to hear that it's safe/stable now!

 

Also, you mention execute being used for offline mode, but the client api warns that it's only available for online - is that not the case for the component framework implementation? That would be awesome!

 

skoofy5_1-1648444500368.png

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @skoofy5 , 

 

For the Xrm.WebApi there are not only the "online" or "offline" modes, but also we find the methods directly in the Xrm.WebApi namespace, which takes care by themselves if the user is online or offline and calls the appropriate method: https://docs.microsoft.com/en-us/powerapps/developer/model-driven-apps/clientapi/reference/xrm-webap...

I think this is similar with the PCF webAPI methods. It's true that is not specified in the docs, but it's also not stated that it won't work offline.

 

I've actually made a test using the WebAPI Sample PCF: https://docs.microsoft.com/en-us/powerapps/developer/component-framework/sample-controls/webapi-cont.... It worked in offline mode without problems. Also the Dataset .save() method worked in offline mode too.

In both cases, the changes were sync as soon I've changed to online mode.

 

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

Helpful resources

Announcements

Celebrating the May Super User of the Month: Laurens Martens

  @LaurensM  is an exceptional contributor to the Power Platform Community. Super Users like Laurens inspire others through their example, encouragement, and active participation. We are excited to celebrated Laurens as our Super User of the Month for May 2024.   Consistent Engagement:  He consistently engages with the community by answering forum questions, sharing insights, and providing solutions. Laurens dedication helps other users find answers and overcome challenges.   Community Expertise: As a Super User, Laurens plays a crucial role in maintaining a knowledge sharing environment. Always ensuring a positive experience for everyone.   Leadership: He shares valuable insights on community growth, engagement, and future trends. Their contributions help shape the Power Platform Community.   Congratulations, Laurens Martens, for your outstanding work! Keep inspiring others and making a difference in the community!   Keep up the fantastic work!        

Check out the Copilot Studio Cookbook today!

We are excited to announce our new Copilot Cookbook Gallery in the Copilot Studio Community. We can't wait for you to share your expertise and your experience!    Join us for an amazing opportunity where you'll be one of the first to contribute to the Copilot Cookbook—your ultimate guide to mastering Microsoft Copilot. Whether you're seeking inspiration or grappling with a challenge while crafting apps, you probably already know that Copilot Cookbook is your reliable assistant, offering a wealth of tips and tricks at your fingertips--and we want you to add your expertise. What can you "cook" up?   Click this link to get started: https://aka.ms/CS_Copilot_Cookbook_Gallery   Don't miss out on this exclusive opportunity to be one of the first in the Community to share your app creation journey with Copilot. We'll be announcing a Cookbook Challenge very soon and want to make sure you one of the first "cooks" in the kitchen.   Don't miss your moment--start submitting in the Copilot Cookbook Gallery today!     Thank you,  Engagement Team

Announcing Power Apps Copilot Cookbook Gallery

We are excited to share that the all-new Copilot Cookbook Gallery for Power Apps is now available in the Power Apps Community, full of tips and tricks on how to best use Microsoft Copilot as you develop and create in Power Apps. The new Copilot Cookbook is your go-to resource when you need inspiration--or when you're stuck--and aren't sure how to best partner with Copilot while creating apps.   Whether you're looking for the best prompts or just want to know about responsible AI use, visit Copilot Cookbook for regular updates you can rely on--while also serving up some of your greatest tips and tricks for the Community. Check Out the new Copilot Cookbook for Power Apps today: Copilot Cookbook - Power Platform Community.  We can't wait to see what you "cook" up!      

Tuesday Tip | How to Report Spam in Our Community

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn!   Today's Tip: How to Report Spam in Our Community We strive to maintain a professional and helpful community, and part of that effort involves keeping our platform free of spam. If you encounter a post that you believe is spam, please follow these steps to report it: Locate the Post: Find the post in question within the community.Kebab Menu: Click on the "Kebab" menu | 3 Dots, on the top right of the post.Report Inappropriate Content: Select "Report Inappropriate Content" from the menu.Submit Report: Fill out any necessary details on the form and submit your report.   Our community team will review the report and take appropriate action to ensure our community remains a valuable resource for everyone.   Thank you for helping us keep the community clean and useful!

Community Roundup: A Look Back at Our Last 10 Tuesday Tips

As we continue to grow and learn together, it's important to reflect on the valuable insights we've shared. For today's #TuesdayTip, we're excited to take a moment to look back at the last 10 tips we've shared in case you missed any or want to revisit them. Thanks for your incredible support for this series--we're so glad it was able to help so many of you navigate your community experience!   Getting Started in the Community An overview of everything you need to know about navigating the community on one page!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Ranks and YOU Have you ever wondered how your fellow community members ascend the ranks within our community? We explain everything about ranks and how to achieve points so you can climb up in the rankings! Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Powering Up Your Community Profile Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile. Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Blogs--A Great Place to Start There's so much you'll discover in the Community Blogs, and we hope you'll check them out today!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Unlocking Community Achievements and Earning Badges Across the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. Check out some details on Community badges--and find out more in the detailed link at the end of the article! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Blogging in the Community Interested in blogging? Everything you need to know on writing blogs in our four communities! Get started blogging across the Power Platform communities today! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Subscriptions & Notifications We don't want you to miss a thing in the community! Read all about how to subscribe to sections of our forums and how to setup your notifications! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Getting Started with Private Messages & Macros Do you want to enhance your communication in the Community and streamline your interactions? One of the best ways to do this is to ensure you are using Private Messaging--and the ever-handy macros that are available to you as a Community member! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Community User Groups Learn everything about being part of, starting, or leading a User Group in the Power Platform Community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Update Your Community Profile Today! Keep your community profile up to date which is essential for staying connected and engaged with the community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Thank you for being an integral part of our journey.   Here's to many more Tuesday Tips as we pave the way for a brighter, more connected future! As always, watch the News & Announcements for the next set of tips, coming soon!

Hear what's next for the Power Up Program

Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram, including a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the link below to sign up today! https://aka.ms/PowerUp  

Users online (3,203)