Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Application Integration
  • All Products

Table of Contents

Search

  1. Preface
  2. Runtime tasks for processes
  3. Runtime tasks for guides
  4. Publishing Application Integration assets in bulk
  5. Unpublishing Application Integration assets in bulk
  6. XML parsing
  7. Appendix A: HTTP response status codes

Invoke

Invoke

Back Next

OpenAPI JSON specification of a process

OpenAPI JSON specification of a process

The OpenAPI specification, previously called Swagger specification, is a format for describing REST API endpoints.
Application Integration supports OpenAPI specification version 3.0.1. You can view the OpenAPI specification of the payload of a process that you create in Process Designer.
The OpenAPI JSON specification of a process contains process payload information such as input, output, descriptions, and process objects. The OpenAPI specification specifies the standard OpenAPI property requirements of
version
,
info
,
servers
,
paths
, and
components
.
The OpenAPI 3.0.1 specification is more descriptive than Swagger 2.0 and allows you to create complex documents.

Accessing the OpenAPI JSON specification of a process

To access the OpenAPI 3.0 specification of a process, perform the following steps:
  1. On the
    Explore
     page, navigate to the process for which you want to view the OpenAPI specification.
  2. On the
    Actions
     menu, click
    Properties Detail
     to view the generated OpenAPI file.
    The
    Properties Detail
     dialog box appears.
    The following image shows the link to access the OpenAPI 3.0 file:
    The image shows the generated OpenAPI file.
  3. Click
    View OpenAPI 3.0 File
     to view the associated OpenAPI file.
    The OpenAPI 3.0.1 specification opens on a new tab.
The OpenAPI 3.0.1 specification for the processes shows the HTTP response status code, step name, and the HTTP response header name and type that you configured in the End step or the Milestone step. However, if a process contains a Receive step, the HTTP response status code remains
200 OK
 irrespective of the configuration. For more information about the response status codes that
Application Integration
 supports, see Appendix- Response Status Codes.
0 COMMENTS
We’d like to hear from you!