{"id":2236,"date":"2016-04-15T18:58:40","date_gmt":"2016-04-15T18:58:40","guid":{"rendered":"http:\/\/himbap.com\/blog\/?p=2236"},"modified":"2016-04-15T19:15:34","modified_gmt":"2016-04-15T19:15:34","slug":"calling-custom-actions-using-web-api","status":"publish","type":"post","link":"https:\/\/himbap.com\/blog\/?p=2236","title":{"rendered":"Calling Custom Actions using Web API"},"content":{"rendered":"

In our last web API articles, we discussed about using web API actions<\/a>, today we are going to discuss about calling our custom actions using web API. If you are new to action you can refer this KB<\/a> to know about actions.
\nLet\u2019s take a scenario that we want to design one action for our custom event entity to approve event based on it\u2019s budget field value, for example if budget is more than 50000 then it will be approved otherwise not. This action will have only one output parameter, which will return true or false based on\u00a0event is approved or not. So let\u2019s design our action first, using following steps:
\n1. Navigate to Settings->Customizations->Customize the system<\/strong>.
\n2. Navigate to Components->Entities->New<\/strong> under solution and create a custom Event entity with two below custom attributes:
\nName<\/strong>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Data Type<\/strong>
\nEvent Approved\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Two Options
\nEvent Budget\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0Currency
\n3. Place these field over Main<\/strong> form and Publish<\/strong> your customization.
\n4. Navigate to Settings->Processes->New<\/strong> and use following details and click on Ok.
\n\"budgetapprovalaction\"<\/a>
\n5. Setup an output argument using following details:
\n\"outputparameter\"<\/a>
\n6. Click on Add Step<\/strong> drop down button and add a Check Condition<\/strong> step.
\n7. Configure this steps using following condition and click on Save and Close<\/strong> button:
\n\"checkcondition\"<\/a>
\n8. Click on the row immediate after Check Condition<\/strong> and add an update step.
\n9. Click on Set Properties<\/strong> button and set Event Approval<\/strong> to Yes<\/strong>, like below:
\n\"eventapproved\"<\/a>
\n10. Now click on if condition and add Default<\/strong> step from Add Step<\/strong> drop down.
\n11. Similarly add an update steps immediate after Otherwise<\/strong> setp and this time set Event Approved<\/strong> to false using Set Properties<\/strong> button.
\n12. Now add a Assign Value<\/strong> step outside of if condition scope and assign Event Approved<\/strong> field value to output argument like following screenshot:
\n\"assignvalue\"<\/a>
\n13. Finally action steps should be similar to following screenshot, now activate action using Activate<\/strong> button on toolbar.
\n\"fullaction\"<\/a><\/p>\n

Now our action is ready, just make sure to note down name of the action and output argument we during Web API call. As we don’t have any input argument that we need to pass, so we can simply pass our event id and call our custom action using it’s name like below. After that we can capture output argument under data collection.<\/p>\n

\r\nfunction Callcustomaction() {\r\n    var Id = Xrm.Page.data.entity.getId().substring(1, 37);\r\n    var serverURL = Xrm.Page.context.getClientUrl();\r\n\r\n    var req = new XMLHttpRequest();\r\n    req.open("POST", serverURL + "\/api\/data\/v8.0\/dev_events(" + Id + ")\/Microsoft.Dynamics.CRM.new_CheckforBudgetApproval", true);\r\n    req.setRequestHeader("Accept", "application\/json");\r\n    req.setRequestHeader("Content-Type", "application\/json; charset=utf-8");\r\n    req.setRequestHeader("OData-MaxVersion", "4.0");\r\n    req.setRequestHeader("OData-Version", "4.0");\r\n    req.onreadystatechange = function() {\r\n        if (this.readyState == 4 \/* complete *\/ ) {\r\n            req.onreadystatechange = null;\r\n            if (this.status == 200) {\r\n                var data = JSON.parse(this.response);\r\n                if (data['Approved'] != null)\r\n                    alert(data['Approved']);\r\n            } else {\r\n                var error = JSON.parse(this.response).error;\r\n                alert(error.message);\r\n            }\r\n        }\r\n    };\r\n    req.send();\r\n}\r\n<\/pre>\n
We can use above code in script web resource and can call Callcustomaction<\/strong> method on some ribbon button or some form\/or field event to test it.<\/p>\n","protected":false},"excerpt":{"rendered":"
In our last web API articles, we discussed about using web API actions, today we are going to discuss about calling our custom actions using web API. If you are new to action you can refer this KB to know about actions. Let\u2019s take a scenario that we want to design one action for our custom event entity to approve… Read more »<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[21,275,296],"tags":[355,354,281],"_links":{"self":[{"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/2236"}],"collection":[{"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2236"}],"version-history":[{"count":8,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/2236\/revisions"}],"predecessor-version":[{"id":2253,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/2236\/revisions\/2253"}],"wp:attachment":[{"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2236"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2236"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/himbap.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2236"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}