webMethods

webMethods

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only

Automation using IBM webMethods Integration APIs

By Wayne Leishman posted 14 days ago

  

You should be aware that there are APIs available for IBM webMethods Integration (SaaS).



Note: There are APIs available for other webMethods products, but this blog is about the webMethods Integration (SaaS) product APIs 



Also, in this case I’m referring to the webMethods Integration APIs for SaaS product, and not the APIs for Software product. 



Note: IBM uses the term Software to indicate products that need to be installed and configured on hardware. Sometimes referred to as On-Premises.
They use the term SaaS to indicate cloud products that are hosted/managed by IBM.



Why Use APIs?



They are handy for scripting, automation (DevOps / CICD), or just avoiding the UI.



You can do pretty much everything via REST (and SOAP if you're into that). For example: managing projects, running FlowServices/Workflows, tweaking configs, pulling logs, all with API calls.



Here is a summary of what the APIs can do:



🔹 Running Workflows or Flow Services from CI/CD
You can POST to an endpoint to run a Workflow or a Flow Service. Just grab the UID (for Workflows) or the Flow name (for Flow Services) from the URL, pass in your inputs (if needed), and monitor execution logs using the Metrics or Execution Logs APIs. Great for test automation or deploying integration changes.



🔹 Automating project operations
Creating, listing, cloning, exporting, importing and deleting projects: possible using the /projects resource in the REST API.



I have recently used export to backup my Project (with all dependencies) into zip file. Of course the import can be used to re-import the Projects.



🔹 Pulling logs 
There’s an API that returns structured execution logs, filtered by status, project, or even time range. Example: pulled logs for failed executions.



🔹 Managing accounts and connector configs
You can list all your configured accounts, see which are used, and even switch one out via API.



🔹Working with reference data
Need to update a lookup table used in a Flow Service? Push a new CSV, update encoding, delimiters, via the APIs.



🔹 Recipes
The Recipes API lets you create, retrieve, list, and delete recipes, making it easy to reuse and share across tenants.



🧾Here’s a link to the API documentation for IBM webMethods Integration: https://www.ibm.com/docs/en/wm-integration/11.0.11?topic=apis



You can also search this community for other articles and blogs on APIs for webMethods. However, pay attention to the date posted, since some info may refer to earlier versions of the product(s)



ℹ️ Disclaimer: in many/most automated CI/CD processes, some use of the UI will be required. The goal is to automate as much as possible.





Wayne Leishman



webMethods Practice Lead @ CoEnterprise







1 comment
46 views

Permalink

Comments

Thanks for sharing