{"id":11663,"date":"2022-02-09T11:15:19","date_gmt":"2022-02-09T17:15:19","guid":{"rendered":"https:\/\/www.mrc-productivity.com\/docs\/?post_type=ht_kb&p=11663"},"modified":"2023-08-07T10:01:38","modified_gmt":"2023-08-07T15:01:38","slug":"using-a-maintainer-to-call-web-services-api","status":"publish","type":"ht_kb","link":"https:\/\/www.mrc-productivity.com\/docs\/knowledge-base\/using-a-maintainer-to-call-web-services-api","title":{"rendered":"Using a Maintainer to call Web Services API"},"content":{"rendered":"\n

Overview<\/h3>\n\n\n\n

This enhancement allows developers to call web service endpoints from m-Power maintainer applications on add\/update\/delete actions. <\/p>\n\n\n\n

This feature only applies to bootstrap Data List with Web Form and Single Web Form templates.<\/p>\n\n\n\n

This enhancement utilizes both the dictionary level web service endpoint configuration as well as the maintainer workflow designer to fully configure and customize the web service integration.<\/p>\n\n\n\n

The configuration of authentication methods and dictionary sign on for read-only web services (documented here<\/a>) also applies to maintenance web service call<\/p>\n\n\n\n

Configure Web Service at Dictionary Level<\/h3>\n\n\n\n

Configure the web service at the dictionary admin level just as you would for a read-only web service. There is no need to provide a sample body or configure web service fields for a web service endpoint that is write only (POST, PUT, DELETE). You can leave those tabs in the interface blank. Navigate to Admin -> Web Services -> Web Service Endpoints. Then “Register New Web Service”<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Create Maintainer that will Invoke Web Service<\/h3>\n\n\n\n

Create your maintainer just as you would any other normal application. <\/p>\n\n\n\n

Some users don’t want m-Power to write to the database when calling an API. If this applies to you, you should set the Skip Database Actions options to Yes in your Maintainer’s Application Property window.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Invoke API via Workflow<\/h3>\n\n\n\n

Next, open the Workflow designer in the maintainer you just created. Create a conditional node to set whether you want to call your web service on add or update or delete.
<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Select the Conditional option of “Check the Action Mode (Add\/Update\/Delete)”<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

<\/p>\n\n\n\n

Name the condition, and select the appropriate action. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Add an action \u201cIf True\u201d to the condition. Use the \u201cCall an external API\u201d action type. The API configuration modal provides a list of all the web service endpoints configured at the dictionary level. Select the appropriate web service you created earlier in this document:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

In the image above, note the API Message Body, this is where you configure the message body to be posted to your web service endpoint. The interface allows for JSON or URL encoded form content types (shown above). The API dialog will attempt to construct a default message body using all the fields from the maintainer. It is likely not exactly what you want to POST but serves as an example or starting point to construct your message body. You can change any part of this body as needed to match the parameter names expected by your web service or remove fields not needed. The \u201cMXXXX.fieldname.type\u201d strings are field substitutions that will be replaced at runtime with values submitted from the app\/webform.  <\/p>\n\n\n\n

If you need help creating the field substitutions, just type the open square bracket key [ and select from the list of maintainer fields. It will insert the appropriate substitution for you.<\/p>\n\n\n\n

Running the Application<\/h3>\n\n\n\n

At runtime, the user will interact with maintainer just like they would any standard m-Power built application. However, when the user submits the record, based on the rules found in the Workflow designer, the app will trigger the API call as specified above. <\/p>\n","protected":false},"excerpt":{"rendered":"

Overview This enhancement allows developers to call web service endpoints from m-Power maintainer applications on add\/update\/delete actions. This enhancement utilizes both the dictionary level web service endpoint configuration as well as the maintainer workflow designer to fully configure and customize the web service integration. Configure Web Service at Dictionary Level…<\/p>\n","protected":false},"author":1,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[],"ht-kb-tag":[281],"class_list":["post-11663","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_tag-web-services"],"_links":{"self":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11663","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/comments?post=11663"}],"version-history":[{"count":6,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11663\/revisions"}],"predecessor-version":[{"id":13127,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11663\/revisions\/13127"}],"wp:attachment":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/media?parent=11663"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-category?post=11663"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-tag?post=11663"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}