REST API Calls with Query Parameters in BizTalk: A Step-by-Step Guide

 Introduction

In this blog, I will provide a comprehensive guide on how to call a REST API that requires query parameters. We'll walk through the necessary steps to set up the environment and make successful API calls.

Solution

High Level Steps

1. API Overview:

We will be using an open API for demonstration purposes. The API endpoint we'll be working with is:

https://randomuser.me/api/?results=1

2. Schema Creation:

  • Create a schema named "SourceA" that matches the structure of the messages you'll be dropping in the receive location.



  • To create a JSON response schema, follow these steps: capture the JSON response by running a test in Postman, and then utilize a JSON schema generator to create the desired JSON schema.

3. Field Promotion:

  • In the SourceA schema, promote the field called "results." This field will serve as the variable for the query parameter.



4. Receive JSON Pipeline:

  • Develop a receive JSON pipeline that can receive JSON messages and convert them into XML messages, preparing them for further processing.

  • The JSON decoder properties should be as shown below. 


  • Deploy the schema project and the pipeline project

5. Receive Port and Location Setup:

  • Create a receive port and, within it, establish a receive location.


6. Send Port Set Up
  • Set up a request-response send port using the WCF-WebHTTP adapter to call the REST API.


  • HTTP method and URL mapping details are given below

<BtsHttpUrlMapping> 
<Operation Method="GET" Url="/api?results={results}" /> 
</BtsHttpUrlMapping>
  • Under the Messages tab set "Suppress Body" for Verbs to "GET"


  • Configure the send port to subscribe to the receive port.


  • Create a separate send port to subscribe to the response message and archive it for future reference.



7. Testing:

With the setup complete, drop a message with the "SourceA" schema in the receive location.

Observe that the REST API is successfully called, and the response message is received and archived for further analysis.

8. Code

The project is uploaded at the following location

https://drive.google.com/file/d/1uvlDP36xVgxaFi6VKzDnxqjls_pyjuop/view?usp=sharing

Comments

Post a Comment

Popular posts from this blog

EDI X12 Trading partner configuration in BizTalk

Image
 Introduction In this blog post, we will explore the process of setting up trading partner configuration in BizTalk. This involves creating parties, configuring agreements, and testing the solution. Let's dive into the details. Steps Creating parties in BizTalk To begin, we need to create two parties - one for our company and another for our trading partner. Let's start by creating the party for our company named "Vipin." Follow these steps: Connect to the BizTalk Admin console. Right-click on "Party" and select "New" -> "Party." Name the party as "Vipin" and click on OK Creating the party will also create the profile for you. Next, let's create the party for our trading partner, "ABCCompany" by following the same steps. Understanding the X12 File Now, in order to configure the agreement, we need to have a sample X12 EDI message that "ABCCompany" will be sending to our company, "Vipin." Let...
Read more

How to create an EDI 850 profile in Boomi?

Image
Here is a sample EDI profile that I downloaded from the internet. ISA*01*0000000000*01*0000000000*ZZ*ABCDEFGHIJKLMNO*ZZ*123456789012345*101127*1719*U*00400*000003438*0*P*> GS*PO*4405197800*999999999*20101127*1719*1421*X*004010VICS ST*850*000000010 BEG*00*SA*08292233294**20101127*610385385 REF*DP*038 REF*PS*R ITD*14*3*2**45**46 DTM*002*20101214 PKG*F*68***PALLETIZE SHIPMENT PKG*F*66***REGULAR TD5*A*92*P3**SEE XYZ RETAIL ROUTING GUIDE N1*ST*XYZ RETAIL*9*0003947268292 N3*31875 SOLON RD N4*SOLON*OH*44139 PO1*1*120*EA*9.25*TE*CB*065322-117*PR*RO*VN*AB3542 PID*F****SMALL WIDGET PO4*4*4*EA*PLT94**3*LR*15*CT PO1*2*220*EA*13.79*TE*CB*066850-116*PR*RO*VN*RD5322 PID*F****MEDIUM WIDGET PO4*2*2*EA PO1*3*126*EA*10.99*TE*CB*060733-110*PR*RO*VN*XY5266 PID*F****LARGE WIDGET PO4*6*1*EA*PLT94**3*LR*12*CT PO1*4*76*EA*4.35*TE*CB*065308-116*PR*RO*VN*VX2332 PID*F****NANO WIDGET PO4*4*4*EA*PLT94**6*LR*19*CT PO1*5*72*EA*7.5*TE*CB*065374-118*PR*RO*VN*RV0524 PID*F****BLUE WIDGET PO4*4*4*EA PO1*6*696*EA*9.55*T...
Read more

Basics of Correlation in BizTalk

Image
 Introduction In this blog, we will try to understand the basics of Correlation. In some cases, we would want the message to be correlated to another message in the message box and we can use correlation set and correlation Type to achieve this. Sometimes, it's not just about connecting messages. We may also need to attach additional properties to a message, such as a unique GUID or an application identifier, and promote these properties on to the context. We can also achieve this using Correlation Type and correlation set. Think of Correlation Type as a class, and Correlation Set as an instance of that Class.  Process Flow Schema Creation Create an Order schema with a field called Order. Distinguish this field Create an Ack Schema with a field called Status Create a Property Schema with 4 fields and set the property base of the fields to "MessageContextPropertyBase": Application Order Application1 Order1 Maps Create a map and name it "Order_TO_Ack". Source Sche...
Read more