The JSON (JavaScript Object Notation) is the data-interchange format used by TIBCO EBX®'s RESTful operations.
This format is lightweight, self-describing and can be used to design UIs or to integrate EBX® in company's information system.
The following JSON formats are available:
Using the extended format, the data context is exhaustive and contains features to retrieve metamodel data, labels, validation report, inheritance data, URLs (OpenAPI, details, selector, historyDetails, etc.), history advanced data, except for association fields and selection nodes. However, these fields are reachable from the response through URL links called details included by default.
Using the compact format, the data context is limited to master data without metamodel data except links for enumerated fields.
The amount of retrieved data is limited by a pagination mechanism which can be configured.
URL links allow reaching:
Tables, records, dataset non-terminal nodes, foreign keys, resource fields through the details property. See includeDetails for more information.
Possible values for foreign keys or enumerations, by activating the selector parameter. See includeSelector for more information.
JSON data are always encoded with the UTF-8 charset.