This section provides the following details on REST support in
TIBCO® Cloud Integration:
What is REST? Representational State Transfer (REST) is a platform-and-language-independent
architectural style used in building services for distributed systems and networked applications. REST ignores the details of component implementation and protocol syntax. It uses HTTP to make calls between the applications.
What is Swagger? Swagger is a specification which is used to define a REST interface that has operations and parameters. Documents used by the REST API to send requests and receive responses are often written according to the Swagger specification.
About REST Services and References A REST service or a reference is created from a process within a project. The content of the process resides in an XSD file in the
Schemas folder of the project.
Restrictions There are certain rules to follow when working with JSON and XML Schema.
Parameter Support REST operations support path, query, form, and header parameters. You can pass path and query parameters to an operation by appending them to the request URL. Header parameters are used to pass and receive information in the HTTP envelope containing the message body.
REST Schema Utilities TIBCO Business Studio™ provides utilities to convert objects from JSON to XSD elements.
Importing an API Model into your Workspace The APIs that are discovered from local and remote servers are displayed in the
API Explorer tab of the TIBCO Business Studio™. You can use these APIs in your project by importing them into the
Service Descriptors folder of the project. The
.json file for the API gets copied into the application module.
REST Service The REST service is a server process. When running, it can be invoked by a REST reference.
REST Reference A REST reference is a client process that is used to invoke an external REST service. The service must be running and accessible from the system where the reference resides at the time of its invocation.
Exception Handling Errors (or faults) can occur when executing a process. Using fault handlers you can catch faults or exceptions and create fault-handling procedures to deal with potential runtime errors in your process definitions.