In this article, we will take a detailed look into one HTTP GET method API that will, say, retrieve the list of BizTalk application names in the environment. Lets say you want to use the information about the names of BizTalk applications in your SharePoint, or in a custom dashboard within your team/a different team in the organization. In this situation, you need not write any custom piece of code that will retrieve the BizTalk application names from the environment. With BizTalk360 API documentation in place, it becomes easy for users to make use of the BizTalk360 APIs to retrieve the list of BizTalk application names from the environment.
Let's take a detailed look into the different sections in the HTTP GET Method -
- GET/POST - Displays the type of method used by the service. If it is a GET method, you will notice GET. If it is a POST method, you will notice a POST.
- Service Name - Displays the Name of the backend REST service
- Service Name (hyperlink) - Click to expand/collapse the service details section
- Implementation Notes - Provides detailed information about what the service will do. In this case, the implementation notes provide information such as the selected API will return the list of BizTalk Application names from the environment.
Response Class - This section displays the sample of the response (an Example JSON) that you will see after you execute the API. If the API was successfully able to retrieve the BizTalk application names in the environment, you will see a response status with "success: true" and the list of BizTalk applications names.
You have the option of viewing the detailed schema (with explanation) of the response code by clicking on the Schema link.
- Response Content Type - Choose the response content type that you would like to see from the drop down (for instance, application/json)
Parameters - Before actually implementing the API for your custom purpose, you can actually visualize the output that you will see if you execute the API. To try this out, the Parameters section plays an important role. This is where you need to enter the Environment ID to test out the result of the API.Most of the APIs require the environment ID as the parameter in order for you to try it out. For easy access, you will notice the environment ID in the Environment Details section. You can copy and paste it wherever appropriate.
- Parameter - Specifies the list of parameters that are required as an input for the API to retrieve the information from the BizTalk environment
- Value - Enter the value in the space provided
- Description - Provides a detailed description about the parameter that has to be provided as an input value for the API
- Parameter Type - Specifies the type of the parameter that is being given as the input, for instance, query
Data Type - Specifies the data type of the parameter that is being given as the input, for instance, string, integer
The following screenshots show the different types of Parameters section available with different API service calls.
Try it out
Click the Try it out! button to see the actual response from the API service call.
- Request URL - Displays the URL (API) that is passed to the BizTalk server to retrieve the information, in this case, the list of BizTalk application names
- Response Body - If the API was successfully able to retrieve the BizTalk application names in the environment, you will see a response status with "success: true" and the list of BizTalk applications names. Otherwise, you will notice the response status with "success:false" and an exception message regarding the error.
- Response Code - The response code will display the value as 200 if the API was successfully able to retrieve the requested information from the BizTalk server environment
- Response Headers - Displays the response headers for the API call that retrieves the information from the BizTalk server
- Hide Response - Click the link to Hide the response section beneath the Try it out! button