Skip Ribbon Commands
Skip to main content
Navigate Up
Sign In

Quick Launch

Average Rating:

(3 Ratings)
facebook Twitter
Email
Print Bookmark Alert me when this article is updated

Feedback

HOW TO: Generate Swagger file in IICS
Solution
To generate Swagger file in IICS one need to do the following:
  • Login to IICS Org.
  • Go to the Administrator Section. 
  • Then go to Swagger files.
  • Click on New.
  • Swagger Generation page will appear.
swagger1.png

  • Fill in the details according to the type of REST call(Get, Post, Put, Delete) and click OK.
  • An entry for the file will be created in the Swagger page.
  • Click download to save the Swagger file to a local directory in Secure Agent machine.
NOTE
 
License required to use this utility is as follows:
  • RESTSwaggerGenerator package license.

Make sure you divide the URL in 3 parts(URL,Api Base Path,Api Path) when generating the Swagger file ex:
https://app.informaticaondemand.com/ma/api/v2/user/login
Here Url       -   https://dm-us.informaticacloud.com
Api Base Path -  /ma
Api Path - /api/v2/user/login


An alternate way to generate Swagger file:

  • In this way also one needs to specify the details as specified above.
  • Along with that upload the Api response as a Json file in the JSON Response File section.
  • Click Ok.
  • An entry for the file will be created in the Swagger page.
  • Click download to save the Swagger file to a local directory in Secure Agent machine.

swagger2.PNG
​​​
More Information
​Difference between the two is in the First method a call is made to Api before Swagger generation but in Second mothod no Api call is made.
​Note that API Base Path & API Path are the mandatory fields here. For more information refer the following guide:
Reference
​Note that API Base Path & API Path are the mandatory fields here. For more information refer the following guide:
Applies To
Product: Cloud Data Integration
Problem Type: Configuration
User Type: Architect
Project Phase: Implement
Product Version:
Database:
Operating System:
Other Software:
Attachments
Last Modified Date:1/30/2020 4:48 AMID:527268
People who viewed this also viewed

Feedback

Did this KB document help you?



What can we do to improve this information (2000 or fewer characters)