Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# OpenAPI Specification Support

You can generate the OpenAPI specification for your TIBCO BusinessEvents REST API application that another TIBCO BusinessEvents application or any third-party product can easily consume. The OpenAPI specification contains all the underlying configurations of your application and exposes the capabilities of your application in an easily readable JSON or YAML format.

The consuming application can interpret the OpenAPI specification and create the project artifacts based on its contents: the concepts, events with or without payload (ontology concept ref or XSD element ref or complex element payload), destinations, channels, and shared resources.

TIBCO BusinessEvents supports the OpenAPI specification for only HTTP channel applications.

To know more about OpenAPI specification, see OpenAPI documentation.

For details about the supported versions, see the Readme.txt file available at the TIBCO BusinessEvents® Enterprise Edition Product Documentation page.

Note: The following artifact fields are not supported when a TIBCO BusinessEvents project is exported using the OpenAPI Specification:

- Concept TTL and Event TTL
- Channel SSL section
- SSL fields
- Pageflow type for HTTP Channel
- Description field for a channel, destination, event, and shared connection

The following artifact fields are not supported when a TIBCO BusinessEvents project is imported using the OpenAPI Specification:

- Third-party specification having object type as array. The array property in Event is not supported.

- Event Payload that consists 'XML Element Reference' type under 'Complex Element'

- Nested properties

- When a project has an Event payload with multiple contained and referenced concepts, the import operation does not create all referenced or contained concepts if the x-ConceptPath and x-event-payload type tags are excluded from the exported specification.

Subtopics

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.