Click here to Skip to main content
14,032,307 members
Click here to Skip to main content
Add your own
alternative version


1 bookmarked
Posted 24 Jan 2016
Licenced CPOL

Exposing a REST/JSON GET endpoint using BizTalk Server 2013

, 24 Jan 2016
Rate this:
Please Sign up or sign in to vote.
To Expose BizTalk Schema as a Rest/Json Service with GET method.


As we know how to expose a WCF service as RESTFul service using the POST method. That is direct as we are doing for the exposing normal WCF service.

I tried with the POST method for the RestFull service and I have created it in an hour. But doing the GET endpoint is painful. As we don’t have much document Online. So I have done so much research and found a very good post provide by Steef Jan Wiggers (Microsoft Azure MVP).



Client need to trigger the service without any input, our RestAPI service  should send back the response with JSON format by executing the SQL StoredProcedure.

Using the code


  1. Create two Schema for the WCF Service Request and Response
  2. Create a Table and Stored procedure to retrieve the details from the table without passing a parameter.
  3. Create a Stored procedure schema from the created Storedprocedure.
  4. Create a Map to Map the SP Response to WCF Response
  5. Create a Custom Receive Pipeline to promote a fields. Get from the below URL:

  1. Create a Custom Send Pipeline with JSON Encode  to send JSON message back to the service.
  2. Create an Orchestration to execute the Stored proc and convert the Storedprocedure response to WCF Rest Service response.

Steps to Create Solution:

  1. Create a Schema and promote the field as property promotion.



Promote the tenantId field as a Property promotion.


  1. Add SQL StoredProcedure Schema à Add Generated Item à Consume Adapter service à Add

Provide the corresponding SQL connection string and select Strongly Typed Stored procedure, It create a Schema.


  1. Create a Map, StoredProcedure Response to RestAPI response.



  1. Create Orchestration to retrieve stored procedure and map the SP response to the WCF Service response and send back to the same req-resp port.



  1. Create a Receive Pipeline to promote the fields which we promoted.

Get the HTTP disassembler Pipeline component from the below URL:

Folder: src\HttpDisassembler\


  1. Create a Send pipeline JSON Encoder to convert the xml to JSON.



  1. Build and Deploy the solution to Admin Console.


  1. Create a Service by following the below steps.


Select BizTalk WCF Service Publishing wizard .








Goto IIS HTTPRestServiceDemo Directory Browsing Enable


Then Browse the Service




DocumentSpecname : <Name>, <Assembly>

Eg: DemoSchema.JsonCarrier, DemoSchema, Version=, Culture=neutral, PublicKeyToken=36c63864bb129606


Provide the above details in the DocumentSpecName and Enable the Receive Location by selecting appropriate Pipeline.




To Enable the MetaData follow below steps:

Goto C:\inetpub\wwwroot\HTTPRestServiceDemo Web.config


<behavior name="ServiceBehaviorConfiguration">

          <serviceDebug httpHelpPageEnabled="true" httpsHelpPageEnabled="false" includeExceptionDetailInFaults="false" />

          <serviceMetadata httpGetEnabled="True" httpsGetEnabled="false" />



Make httpGetEnabled= True as above sample.



Now we successfully Published the RestService.

  1. By Default the Exposed service is enabled for the POST method, now we need to change to GET method.
  2. Follow the below steps to make the GET Endpoint.

GOTO Receive Location Configuration


Under HTTP Method Copy paste the below code:



  <Operation Method="GET" Url="/tenantId/{pid}" />

  <Operation Method="GET" Url="/tenantId" />



Goto Edit (Variable Mapping)

propertyNameSpace == https://Carrier.Schema.PropertySchema


Now we converted the POST as GET method successfully.

  1. Now we need to Test the Service.

We can test using Soap UI:


Change the Resource URL from  /HTTPRestServiceDemo/Service1.svc to  /HTTPRestServiceDemo/Service1.svc/tenantId/34 As we promoted the tenantId so the message will automatically triggered to BizTalk.

You will get the response as the above screenshot.



Points of Interest

1. How to Expose the WCF service as a Rest/Json Service.

2. How to Use GET endpoint using BizTalk Server

3. Learn to expose BizTalk Schema as WCF Rest service thro JSON.



This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

AboorvaRaja Ramar
Software Developer (Senior) VNB Consulting Service
India India
I am working as a Sr.BizTalk Developer. I have 6+ yrs of experience in Development,Testing, Designing of BizTalk Solution.
I have worked on different domain and exposed my knowledge.

You may also be interested in...


Comments and Discussions

QuestionThe property values is populating Pin
Member 1197542918-Mar-16 19:25
memberMember 1197542918-Mar-16 19:25 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Permalink | Advertise | Privacy | Cookies | Terms of Use | Mobile
Web05 | 2.8.190419.4 | Last Updated 24 Jan 2016
Article Copyright 2016 by AboorvaRaja Ramar
Everything else Copyright © CodeProject, 1999-2019
Layout: fixed | fluid