REST Binding Type Key Terms
HTTP Connector, Context Root, Media Type, Path Parameters, and Query Parameters are a few key terms used while discussing about the TIBCO ActiveMatrix Binding Type for REST.
For a discussion of general TIBCO ActiveMatrix® Service Grid terms, see the ActiveMatrix® Service Grid documentation. The following list presents the key terms for the TIBCO ActiveMatrix Binding Type for REST.
HTTP Connector
Name of the HTTP Connector resource instance that provides the HTTP transport for Binding Type for REST. Both HTTP and HTTPS are supported. The default is HTTP. You define and name the HTTP Connector at the design-time. At runtime, you need to create a resource of the type HTTP Connector and assign it the name you used at the design-time.
Context Root
Defines the base path for the URLs exposed by the REST binding.
Media Type
Format of the payload that ActiveMatrix Binding Type for REST accepts and produces. On the reference side, XML and standard JSON are supported. On the service side, XML, Standard JSON, and Badgerfish JSON are supported.
Path
You can specify Path as part of the configuration. Path can be any URI on which a given operation can be exposed.
Path Parameters
Path parameters can be configured on the service side and reference side.
On the service side, path parameters should map to the part name defined in the WSDL. Path parameters can be defined on the operation by using the Path field in the UI. For example, if you want to invoke a backend service operation
getBookByTitle(title)
, you can configure the path as
/book/{title}
. Path parameters are supported by parts that are simple types. On the reference side, path parameters can be configured by adding them in the 'Resource Path' field (for example, '/{<pathParameter1>}'
). For the above
getBookByTitle(title)
operation, 'title' can be added as a path parameter using the syntax:
/book/{title}
. Here, /book
is the Resource Path and /{title}
is the Path parameter.
Query Parameters
Query parameters can be configured on the service side and reference side.
On the Service side, query parameters are not configured as part of the path for the operation. TIBCO ActiveMatrix Binding Type for REST expects that the query parameter name matches the part name of the WSDL operation. If you want to use a query parameter, the part name must be a simple type such as string, boolean, int, and so on.
On the reference side, you can configure query parameters by adding them in the "Request Parameters" section of the REST Resource Configuration file.
Note: You cannot add
Content-Type
or
Accept
as a
Request Parameter
.