TIBCO EBX®
Documentation > Developer Guide > REST data services > JSON Formats
Navigation modeDocumentation > Developer Guide > REST data services > JSON Formats

Compact

Introduction

The JSON compact format purpose is to retrieve the master data using a lightweight structure. It follows the key-value design to display data in the simplest way and without any technical information. To activate the compact format, the compact suffixed REST category, like data-compact or form-data-compact, must be used in URL.

Global structure

JSON Request body

The request body is represented by a JSON Object whose content varies according to the operation and the category.

Data category

Only writable fields can be mentioned in the request, this excludes the following cases:

JSON Response body

The response body is represented by a JSON Object whose content depends on the operation and the category.

Data category

Note

Nodes, records and fields property and value may be hidden depending on their resolved permissions (see permissions) .

Content

This section is always included and contains master data without any additional fields.

Node value

The node value contains only the data or the label and the details link in case of enumeration. It is available for all nodes except association and selection.

Content of simple types

Corresponds to a key-value JSON entry which describes the node content.

Content of group, list and enumeration

XML Schema

JSON format

Examples

Group

xs:complexType

Object

Contains a property per sub-node.

Example for a simple-occurrence group.

{
  "road": "11 rue scribe",
  "zipcode": "75009",
  "country": "France"
}

List

maxOccurs > 1

Array

Contains an array of all field occurrences represented by a JSON Object or a simple type.

Each JSON Object is composed of node values .

Example for a multi-occurrence field of xs:int type.

[
  0,
  1,
  2,
  3,
  4
]

Example for a multi-occurrence group.

[
  {
    "road": "11 rue scribe",
    "zipcode": "75009",
    "country": "France"
  },
  {
    "road": "711 Atlantic Ave",
    "zipcode": "MA 02111",
    "country": "United States"
  }
]

Enumeration

xs:string

Object

Contains key, link and label properties.

Example for a foreign key.

{
  "key":"1",
  "details":"http://.../Bdataspace/dataset/root/nationality/FRA",
  "label":"Française"
}
Documentation > Developer Guide > REST data services > JSON Formats