Extended

Dernière publication : Aug 10, 2026
Related information

Introduction

The JSON extended format is used to retrieve master data, technical information and metadata. It is designed in an expanded way that allows to include several features such as validation, sorting and so on. To activate the extended format, the unsuffixed REST category, like data or form-data, must be used in the 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

The request body contains at least a content property which hold master data values.
  • Dataset node
    Specifies the target values of terminal nodes under the specified node. This request is used for the dataset node update operation.
    {
      "content": {
        "nodeName1": {
          "content": true
        },
        "nodeName2": {
          "content": 2
        },
        "nodeName3": {
          "content": "Hello"
        }
      }
    }
    See also:
  • Record
    Specifies the target record content by setting the value of each field. For missing fields, the behavior depends on the request parameter byDelta. This structure is used for table record insert, record update or selector's select operation when local enumeration dependency field values are declared.
    See also:
    Some technical data can be added beside the content property such as lastUpdateDate.
    See also:
    {
      ...
      "lastUpdateDate": "2015-12-25T00:00:00.001",
      ...
      "content": {
        "gender": {
          "content": "Mr."
        },
        "lastName": {
          "content": "Chopin"
        },
        "lastName-en": {
          "content": "Chopin",
          "inheritedFieldMode": "inherit"
        },
        "firstName": {
          "content": "Fryderyk"
        },
        "firstName-en": {
          "content": "Frédéric",
          "inheritedFieldMode": "overwrite"
        },
        "birthDate": {
          "content": "1810-03-01"
        },
        "deathDate": {
          "content": "1849-10-17"
        },
        "jobs": {
          "content": [
            {
              "content": "CM"
            },
            {
              "content": "PI"
            }
          ]
        },
        "infos": {
          "content": [
            {
              "content": "https://en.wikipedia.org/wiki/Chopin"
            }
          ]
        }
      }
    }
    See also:
  • Record fields
    Specifies the target values of fields under the record terminal node by setting the value of each field. For missing fields, the behavior depends on the request parameter byDelta. This structure is only used for table record updates.
    See also:
    {
      "content": [
        {
          "content": "CM"
        },
        {
          "content": "PI"
        }
      ]
    }
    See also:
  • Record table
    Defines the content of one or more records by indicating the value of each field. For missing fields, the behavior depends on the byDelta parameter of the request. This structure is used upon insert or update records in the table.
    {
      "rows": [
        {
          "content": {
            "gender": {
              "content": "M"
            },
            "lastName": {
              "content": "Saint-Saëns"
            },
            "firstName": {
              "content": "Camille"
            },
            "birthDate": {
              "content": "1835-10-09"
            },
            ...
          }
        },
        {
          "content": {
            "gender": {
              "content": "M"
            },
            "lastName": {
              "content": "Debussy"
            },
            "firstName": {
              "content": "Claude"
            },
            "birthDate": {
              "content": "1862-10-22"
            },
            ...
          }
        }
      ]
    }
    See also:
  • Record table to deleted
    Defines one or more records. This structure is used upon deleting several records from the same table.
    {
      "rows": [
        {
          "details": "http://.../root/table/1"
        },
        {
          "details": "http://.../root/table/2"
        },
        {
          "primaryKey": "./oid=3"
        },
        {
          "foreignKey": "4"
        },
        ...
      ]
    }
    See also:
  • Field
    Specifies the target field content. This request is used for field update.
    The request has the same structure as defined in node value by only keeping the content entry. Additional entries are simply ignored.
    See also:
  • Open or close user interface
    Specifies whether the user interface is open or close and the unavailability message.
    {
      "content": {
        "toolStatus": {
          "content": true    // or false
        },
        "toolStatusCloseMessage": {
          "content": "Access is temporarily forbidden for maintenance."
        }
      }
    }
    See also:
    Only writable fields can be mentioned in the request, this excludes the following cases:
  • Association node,
  • Selection node,
  • Value function,
  • JavaBean field that does not have a setter,
  • Unwritable permission on node for authenticated user.

JSON Response body

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

Data category

The selection operation contains two different parts.
The first one named meta contains the exhaustive structure of the response.
The second, regrouping content, rows, pagination... etc, contains the values corresponding to the request.
  • Dataset tree
    Contains the hierarchy of table and non-terminal group nodes.
    {
      "meta": {
        "fields": [
          {
            "name": "rootName",
            "label": "Localized label",
            "description": "Localized description",
            "type": "group",
            "pathInDataset": "/rootName",
            "fields": [
              {
                "name": "settings",
                "label": "Settings",
                "type": "group",
                "pathInDataset": "/rootName/settings",
                "fields": [
                  {
                    "name": "settingA",
                    "label": "A settings label",
                    "type": "group",
                    "pathInDataset": "/rootName/settings/settingA"
                  },
                  {
                    "name": "settingB",
                    "label": "B settings label",
                    "type": "group",
                    "pathInDataset": "/rootName/settings/settingB"
                  }
                ]
              },
              {
                "name": "table1",
                "label": "Table1 localized label",
                "type": "table",
                "minOccurs": 0,
                "maxOccurs": "unbounded",
                "pathInDataset": "/rootName/table1"
              },
              {
                "name": "table2",
                "label": "Table2 localized label",
                "type": "table",
                "minOccurs": 0,
                "maxOccurs": "unbounded",
                "pathInDataset": "/rootName/table2"
              }
            ]
          }
        ]
      },
      "validation": [
        {
          "level": "error",
          "message": "Value must be greater than or equal to 0.",
          "details": "http://.../rootName/settings/settingA/settingA1?includeValidation=true"
        },
        {
          "level": "error",
          "message": "Field 'Settings A2' is mandatory.",
          "details": "http://.../rootName/settings/settingA/settingA2?includeValidation=true"
        }
      ],
      "content": {
        "rootName": {
          "details": "http://.../rootName",
          "openApiDetails": "http://.../api/.../rootName",
          "content": {
            "settings": {
              "details": "http://.../rootName/settings",
              "openApiDetails": "http://.../api/.../rootName/settings",
              "content": {
                "weekTimeSheet": {
                  "details": "http://.../rootName/settings/settingA",
                  "openApiDetails": "http://.../api/.../rootName/settings/settingA"
                },
                "vacationRequest": {
                  "details": "http://.../rootName/settings/settingB",
                  "openApiDetails": "http://.../api/.../rootName/settings/settingB"
                }
              }
            },
            "table1": {
              "details": "http://.../rootName/table1",
              "openApiDetails": "http://.../api/.../rootName/table1",
              "boDetails": "http://.../data-bo/.../rootName/table1"
            },
            "table2": {
              "details": "http://.../rootName/table2",
              "openApiDetails": "http://.../api/.../rootName/table2",
              "boDetails": "http://.../data-bo/.../rootName/table2"
            }
          }
        }
      }
    }
    The meta and validation properties are optional.
    See also:
  • Dataset node
    Contains the list of terminal nodes under the specified node.
    {
      "meta": {
        "fields": [
          {
            "name": "nodeName1",
            "label": "Localized label of the field node 1",
            "description": "Localized description",
            "type": "boolean",
            "minOccurs": 1,
            "maxOccurs": 1,
            "pathInDataset": "/rootName/.../nodeName1"
          },
          {
            "name": "nodeName2",
            "label": "Localized label of the field node 2",
            "type": "int",
            "minOccurs": 1,
            "maxOccurs": 1,
            "pathInDataset": "/rootName/.../nodeName2"
          }
        ]
      },
      "content": {
        "nodeName1": {
          "content": true
        },
        "nodeName2": {
          "content": -5,
          "validation": [
            {
              "level": "error",
              "message": "Value must be greater than or equal to 0."
            }
          ]
        }
      }
    }
    See also:
  • Datasets List
    JSON Object containing the list of root or children datasets for respectively the specified dataspace or dataset.
    Every dataset JSON Object has the following properties:
JSON property
JSON format
Description
Required
key
String
Specifies the dataset formatted key.
Format: [a-zA-Z_][-a-zA-Z0-9_.]*
Yes
label
String
Documentation label in the current locale. It is only present if the value is different from the key.
No
isSelectAllowed
Boolean
Specifies whether the dataset can be selected, according to the user's permissions.
Yes
details
String
Specifies the dataset's REST resource URL.
No
information
String
Specifies the dataset's information REST resource URL.
No
hasChildren
Boolean
Specifies whether the dataset has children, according to the user's permissions.
Yes
children
String
Specifies the dataset's children REST resource URL. It is only present when the hasChildren property key's value is true and a details link is requested.
No
childrenHistory
String
Specifies the history dataset's children REST resource URL. It is only present when the hasChildren property key's value is true and a details link is requested.
See also:
No
{
  "rows": [
    {
      "key": "mydataset",
      "isSelectAllowed": true,
      "details": "http://.../data/v1/BReference/mydataset",
      "information": "http://.../data/v1/BReference/mydataset:information",
      "hasChildren": true,
      "children": "http://.../data/v1/BReference/mydataset:children"
    },
    {
      // Another dataset
    }
  ],
  "pagination": {
    "firstPage": "http://.../data/v1/BReference?pageSize=4",
    "nextPage": "http://.../data/v1/BReference?pageSize=4&firstElementIndex=4",
    "previousPage": null,
    "lastPage": "http://.../data/v1/BReference?pageSize=4&firstElementIndex=8"
  }
}
See also:
  • Dataset information
    JSON Object containing the following properties:
    JSON property JSON format Description Required
    content Object Corresponds to the dataset information. Yes
    key String Specifies the dataset formatted key value. Format: [a-zA-Z_][-a-zA-Z0-9_.]*, limited to 64 characters maximum. Yes
    documentation Array of JSON Object Corresponds to the localized documentation with a JSON Object by locale. No
    locale (nested under the documentation property) String Documentation locale. Yes
    label (nested under the documentation property) String Documentation label. No
    description (nested under the documentation property) String Documentation description. No
    dataModel JSON Object Specifies the dataset schema location. Only packaged in module schemas and publications are supported. Yes
    module (nested under the dataModel property) String Specifies the module name where the dataset schema is located. No
    pathInModule (nested under the dataModel property) String Specifies the path in the module where the dataset schema is located. No
    publication (nested under the dataModel property) String Specifies the publication name of the dataset schema. No
    dataModel (nested under the dataModel property) String Specifies the data model name of the dataset schema publication. No
    versionName (nested under the dataModel property) String Specifies the version name of the dataset schema publication. No
    parent String Specifies the parent dataset formatted key value. If there is no parent, then it holds a null value. Yes
    activated Boolean Specifies whether the dataset is activated. Yes
    owner String Specifies the owner profile. Yes
    creator String Specifies the creator profile. Yes
    creation_time Date Specifies the creation time. Yes
    updater String Specifies the updater profile. Yes
    update_time Date Specifies the update time. Yes
    {
      "content": {
        "key": "mydataset",
        "documentation": [
          {
            "locale": "en-US",
            "label": "My label",
            "description": "My description"
          },
          {
            "locale": "fr-FR",
            "label": "Mon libellé",
            "description": "Ma description"
          }
        ],
        "dataModel": {
           "module": "modulename",
           "pathInModule": "/WEB-INF/ebx/schemas/mydataset.xsd"
        },
        "parent": null,
        "activated": true,
        "owner": "Beveryone",
        "creator": "Uadmin",
        "creation_time": "2023-10-10T15:49:03.023",
        "updater": "Uadmin",
        "update_time": "2023-10-10T15:49:03.005"
      }
    }
    See also:
  • Table
    JSON Object containing the following properties:
    • (Optional) The table metamodel,
    • (Optional) The sort criteria applied,
    • (Optional) The table validation report,
    • The rows property corresponding to a JSON Array of the selected records. Each record is represented by an JSON Object. If no record is selected then the JSON Array is empty.
    • (Optional) the pagination property, containing pagination data.
      {
        "rows": [
          {
            "label": "Claude Levi-Strauss",
            "details": "http://.../root/individu/1",
            "content": {
              "id": {
                "content": 1
              },
              ...
            }
          },
          {
            "label": "Sigmoud Freud",
            "details": "http://.../root/individu/5",
            "content": {
              "id": {
                "content": 2
              },
              ...
            }
          },
          ...
          {
            "label": "Alfred Dreyfus",
            "details": "http://.../root/individu/10",
            "content": {
              "id": {
                "content": 30
              },
              ...
            }
          }
        ],
        "sortCriteria": [
          {
            "path": "/name",
            "order": "lasc"
          },
          ...
        ],
        "pagination": {
          "firstPage": null,
          "previousPage": null,
          "nextPage": "http://.../root/individu?pageRecordFilter=./id=9&pageSize=9&pageAction=next",
          "lastPage": "http://.../root/individu?pageSize=9&pageAction=last"
        }
      }
    See also:
  • Record
    JSON Object containing:
    • The label,
    • (Optional) The record URL,
    • (Optional) The technical data ,
    • (Optional) The table metamodel ,
    • (Optional) The record validation report,
    • (Optional) The inheritance mode of the record, which can be: root, inherit, overwrite or occult.
      See also:
    • The record content.
      {
        "label": "Name1",
        "details": "http://.../rootName/table1/pk1",
        "creationDate": "2015-02-02T19:00:53.142",
        "creationUser": "admin",
        "lastUpdateDate": "2015-09-01T17:22:24.684",
        "lastUpdateUser": "admin",
        "inheritanceMode": "root",
        "meta": {
          "name": "table1",
          "label": "Table1 localized label",
          "type": "table",
          "minOccurs": 0,
          "maxOccurs": "unbounded",
          "primaryKeys": [
            "/pk"
          ],
          "inheritance": "true",
          "fields": [
            {
              "name": "pk",
              "label": "Identifier",
              "type": "string",
              "minOccurs": 1,
              "maxOccurs": 1,
              "pathInRecord": "pk",
              "filterable": true,
              "sortable": true
            },
            {
              "name": "name",
              "label": "Name",
              "type": "string",
              "minOccurs": 1,
              "maxOccurs": 1,
              "pathInRecord": "name",
              "filterable": true,
              "sortable": true
            },
            {
              "name": "name-fr",
              "label": "Nom",
              "type": "string",
              "minOccurs": 1,
              "maxOccurs": 1,
              "inheritedField": {
                "sourceNode": "./name"
              },
              "pathInRecord": "name-fr",
              "filterable": true,
              "sortable": true
            },
            {
              "name": "parent",
              "label": "Parent",
              "description": "Localized description.",
              "type": "foreignKey",
              "minOccurs": 1,
              "maxOccurs": 1,
              "foreignKey": {
                "tablePath": "/rootName/table1",
                "details": "http://.../rootName/table1"
              },
              "enumeration": "foreignKey",
              "pathInRecord": "parent",
              "filterable": true,
              "sortable": true
            }
          ]
        },
        "content": {
          "pk": {
            "content": "pk1"
          },
          "name": {
            "content": "Name1"
          },
          "name-fr": {
            "content": "Name1",
            "inheritedFieldMode": "inherit"
          },
          "parent": {
            "content": null,
            "selector":"http://.../rootName/table1?selector=true",
            "validation": [
              {
                "level": "error",
                "message": "Field 'Parent' is mandatory."
              }
            ]
          }
        },
        "validation": {
          ...
        }
      }
    See also:
  • Fields
    For association or selection nodes, contains the target table with the associated records if, and only if, the includeDetails parameter is set to true.
    For other kinds of nodes, contains the current node value.
    See also:
  • Retrieve the user interface state
    Contains the user interface status and the unavailability message.
    {
      "content": {
        "toolStatus": {
          "content": true,
          "label": "Open",
          "selector": "http://.../domain/toolStatus/toolStatus?selector=true"
        },
        "toolStatusCloseMessage": {
          "content": "Access is temporarily forbidden for maintenance."
        }
      }
    }
    See also:
Note:
Nodes, records and fields, property and values may be hidden depending on their resolved permissions (see permissions) .

Metamodel

This section can be activated on demand with the includeMetamodel parameter. It describes the structure and the JSON typing of the content section.
This section is deactivated by default for selection operations.
See also:

Structure for table

Table metamodel is represented by a JSON Object with the following properties:
JSON property
JSON format
Description
Required
name
String
Specifies the name of the authorized table defined in the model.
Yes
label
String
Specifies the table's label. If undefined, the name of the schema node is returned.
Yes
description
String
Specifies the table's description.
No
type
String
Specifies the node's type, the value is always equal to: table.
Yes
minOccurs
Number
Specifies the number of minimum authorized record(s).
Yes
maxOccurs
Number or String
Specifies the number of maximum authorized record(s) or unbounded.
Yes
history
Boolean
Specifies if the table content is historized. Its value is true if history is activated, false otherwise.
See also:
No
primaryKeyFields
Array
Specifies the primary key composition which is represented as an array of the paths.
Yes
inheritance
Boolean
Specifies whether the dataset inheritance is activated for the table. Its value is true if inheritance is activated, false otherwise.
See also:
No
fields
Array
Specifies the direct children of the record node which are represented as an array of fields. Each field may also recursively contain sub-fields.
Yes

Structure for field

Each authorized field is represented by a JSON Object with the following properties:
JSON property
JSON format
Description
Required
name
String
Specifies the name of the authorized field defined in the model.
Yes
label
String
Specifies the node's label. If undefined, the name of the schema node is returned.
Yes
description
String
Specifies the field's description.
No
type
String
Specifies the field's type, which can be a: simple type, group, table, foreignKey, association, etc.
Yes
minOccurs
Number
Specifies the number of minimum authorized occurrence(s).
Yes
maxOccurs
Number or String
Specifies the number of maximum authorized occurrence(s) or unbounded.
Yes
readOnly
Boolean
Specifies whether the field access permission is defined as read-only from the data model access properties. That is, if its data can be read or written. Its value is true if the field is read only, false otherwise.
See also:
Yes
autoIncrement
Boolean
Specifies whether the field is auto-incremented. This property is only available for integer field type. Its value is true if the field is auto-incremented, false otherwise.
See also:
No
checkNullInput
Boolean
Specifies whether the check of the constraints on null fields, at user input, is activated or not. Its value is true when activated, false otherwise.
The constraint check is activated when the field has the property osd:checkNullInput set to true.
Yes
inheritedField
Object
Holds information related to the inherited field's value source. 
{

  "inheritedField": {

    "sourceRecord": "/path/to/record", // (optional)

    "sourceNode": "./path/to/Node"

  }

}
See also:
No
foreignKey
Object
Holds information related to the target table.
See also:
No (*)
association
Object
Holds information related to the association table.
See also:
No (*)
enumeration
String
Specifies if the field is an enumeration value. Possible values are:
  • dynamic
  • foreignKey
  • nomenclature
  • programmatic
  • resource
  • static
See also:
According to its value, indicates if the field can be used for retrieving possible values by using the selector request parameter.
No
enumerationDependencies
Array of JSON Object
Specifies the metadata enumeration dependencies list. Only available for enumeration types among: foreignKey, dynamic or programmatic.
See also:
No
valueFunction
Boolean
Specifies if the field is a computed value.
See also:
No
linkedField
Object
Holds information related to the linked field.
See also:
No
pathInDataset
String
Specifies the relative field's path starting from the schema node.
No (**)
pathInRecord
String
Specifies the relative field's path starting from the table node.
No (*)
filterable
Boolean
Specifies whether the field can be used to filter records using the filter request parameter.
No (*)
hiddenFilterPolicy
String
Specifies the hidden filter policy.
The possible values are: textSearchOnly, true or false.
See also:
No (*)
sortable
Boolean
Specifies whether the field can be used in sort criteria using the sort request parameter.
No (*)
constraints
Array of JSON Object
Specifies the field's non-programmatic constraints.
See also:
No
fields
Array of JSON Object
Holds the structure and typing of each field group.
No
isBusinessObjectRelation
Boolean
Specifies whether the field structure is in the current table or given through a business object.
No
(*) Only available for table, record and record field operations.
(**) Only available for dataset tree operations.

Structure for foreign key field

The foreign key field metamodel is represented by a JSON Object.
{
  "dataspace": "BAuthors",
  "dataset": "Authors",
  "tablePath": "/root/Authors",
  "details": "http://.../BAuthors/Authors/root/Authors"
}
It holds the following properties:
JSON property
JSON format
Description
Required
dataspace
String
Specifies the target dataspace or snapshot identifier. If not specifies then it corresponds to the same dataspace as the table's one.
No
dataset
String
Specifies the target dataset's identifier. If not specifies then it corresponds to the same dataset as the table's one.
No
tablePath
String
Specifies the target table's path.
Yes
details
String
Specifies the target table's REST resource URL.
See also:
No
historyDetails
String
Specifies the history target table's REST resource URL.
See also:
No

Structure for the association field

The association field metamodel is represented by a JSON Object. This object holds properties which depend on the association type:
  • tableRefInverse
    {
      "type": "tableRefInverse",
      "dataspace": "BTitles",
      "dataset": "Titles",
      "tablePath": "/root/Titles",
      "details": "http://.../BTitles/Titles/root/Titles",
      "fieldToSource": "/root/Titles/au_id",
      "filter": "./unit_price > 10"
    }
  • linkTable
    {
      "type": "linkTable",
      "tablePath": "/root/Inventory",
      "details": "http://.../BInventory/Inventory/root/Inventory",
      "linkTablePath": "/root/Inventory",
      "fieldToSource": "/root/Inventory/store",
      "fieldToTarget": "/root/Inventory/item",
      "filter": "./price > 10"
    }
  • xpathLink
    {
      "type": "xpathLink",
      "tablePath": "/root/Inventory",
      "details": "http://.../BAuthors/Authors/root/Inventory",
      "predicate": "/root/Inventory[./price < 100]",
      "filter": "./price > 10"
    }
It holds the following properties:
JSON property
JSON format
Description
Required
type
String
Specifies the association type. The possible values are: tableRefInverse, linkTable, xpathLink
See also:
Yes
dataspace
String
Specifies the target dataspace or snapshot identifier. If not specifies, then it corresponds to the same dataspace as the table's one.
No
dataset
String
Specifies the target dataset's identifier. If not specifies, then it corresponds to the same dataset as the table's one.
No
tablePath
String
Specifies the path of the target table.
Yes
details
String
Specifies the target table's REST resource URL.
See also:
No
fieldToSource
String
Specifies the field which refers to the source table of the association.
Defined if the association type is tableRefInverse or linkTable.
No
fieldToTarget
String
Specifies the path of the field to the target table.
Defined if the association type is linkTable.
No
linkTablePath
String
Specifies the path of the link table.
Defined if the association type is linkTable.
No
predicate
String
Specifies the criteria of the association, relative to the current node.
Defined if the association type is xpathLink.
No
filter
String
Specifies the XPath predicate expression to filter the associated objects.
No

Structure for the linked field

The linked field metamodel is represented by a JSON Object.
{
  "relationshipField": "/au_id",
  "tablePath": "/root/Authors",
  "linkedFieldPath": "/birth_date",
  "details": "http://.../BAuthors/Authors/root/Authors"
}
It holds the following properties:
JSON property
JSON format
Description
Required
relationshipField
String
Specifies the field's path holding the relationship used by this linked field.
See also:
Yes
tablePath
String
Specifies the table's path referred by this linked field.
Yes
linkedFieldPath
String
Specifies the path referred by this linked field.
See also:
Yes
details
URI
Specifies the target table's REST resource URL.
See also:
No
See also:

Structure for the enumeration dependencies

The metamodel enumeration dependency object is represented by a JSON Object.
{
  "localModify": false,
  "dataspace": "BAuthors",
  "dataset": "Authors",
  "targetPath": "/root/Authors",
  "details": "http://.../BAuthors/Authors/root/Authors"
}
It holds the following properties:
JSON property
JSON format
Description
Required
localModify
Boolean
Specifies whether the enumeration dependency field is impacted by modifications performed on a field in the same record.
Yes
dataspace
String
Specifies the target dataspace or snapshot identifier of the enumeration dependency. If not specified then it corresponds to the same dataspace as the record's one.
No
dataset
String
Specifies the target dataset's identifier of the enumeration dependency. If not specifies then it corresponds to the same dataset as the record's one.
No
targetPath
String
Specifies the target path of the enumeration dependency.
Yes
details
String
Specifies the target REST resource table URL of the enumeration dependency.
See also:
No

Sort criteria

The sort criteria, applied to the request, can be returned on demand, by using the includeSortCriteria parameter (deactivated by default). If it is activated, a sortCriteria property is directly added to the response root node.
A sortCriteria property is represented as a JSON Array that contains ordered sort criterion. Each sort criterion corresponds to a JSON Object with the following properties:
JSON property JSON format Description Required
path String Field's path. Yes
order String Possible values are: asc, lasc, desc or ldesc. Yes
The sortByRelevancy property is represented by a JSON Array, itself holding a JSON Object with the following properties:
JSON property JSON format Description Required
order String Defines whether the sort is done in ascending or descending order. Possible values are: lasc or ldesc. See sortByRelevancy for more information. Yes

Validation report

The validation can be activated on demand with the includeValidation parameter (deactivated by default). If it is activated, validation properties are directly added on target nodes with one or several messages. For messages without target node's path, a validation property is added on the root node.
A validation property is represented by a JSON Array, holding a JSON Object per message, corresponding to a validation item, with the following properties:
JSON property
JSON format
Description
Required
level
String
Severity level of the validation item. The possible values are: info, warn, error, fatal.
Yes
message
String
Description of the validation item.
Yes
details
String
corresponding to an absolute URL.
URL of the resource associated with the validation item.
Only available on table and dataset scopes, if the associated resource exist and if it is included.
See also:
No

Constraints

This section is automatically activated when the node has a read-write permission. It provides the non-programmatic constraints declared on the data model.
The constraints property is represented by a JSON Array. Every constraint is taking the form of a JSON Object. They have the following properties:
JSON property
JSON format
Description
Required
type
String
Specifies the type of the constraint
See also:
Yes
level
String
Specifies the severity level of the constraint. The possible values are: fatal, error, warning or info.
Yes
content
Object
Specifies the value of the non-programmatic constraint. This value can be a simple type, like a String, or a JSON Object.
No
min
Integer
Specifies the minimum value for excludeSegment constraint type.
No
max
Integer
Specifies the maximum value for excludeSegment constraint type.
No
message
String
Specifies the validation message returned when the value of the field does not comply with the constraint.
Yes
blocksCommit
String
Specifies the control policy management for blocking or non-blocking constraint.
See Blocking and non-blocking constraints for more information.
No

Constraint Types

This section lists the non-programmatic constraints types.
Type Description
mandatory Defines the field is mandatory
fixedLengthStatic Defines the exact number of characters required for this field.
fixedLengthDynamic Points out a field which provides the exact number of characters required for this one.
minLengthStatic Defines the minimum number of characters allowed for this field.
minLengthDynamic Points out a field which provides the minimum number of characters allowed for this one.
maxLengthStatic Defines the maximum number of characters allowed for this field.
maxLengthDynamic Points out a field which provides the maximum number of characters allowed for this field.
excludeSegment Defines an inclusive range of not allowed values for this field.
excludeValue Defines a list of not allowed values for this field.
fractionDigits Defines the maximum number of decimal allowed for this field.
pattern Defines the regular expression pattern that must be match by the field's value.
totalDigits Defines the maximum number of digits allowed for this integer or decimal field.
boundaryMinInclusiveStatic Defines the minimum value allowed (including the minimum value) for this field.
boundaryMinExclusiveStatic Defines the minimum value allowed (excluding the minimum value) for this field.
boundaryMinInclusiveDynamic Defines a field that provide the minimum value allowed (including the minimum value) for this field.
boundaryMinExclusiveDynamic Defines a field that provide the minimum value allowed (excluding the minimum value) for this field.
boundaryMaxInclusiveStatic Defines the maximum value allowed (including maximum value) for this field.
boundaryMaxExclusiveStatic Defines the maximum value allowed (excluding the maximum value) for this field.
boundaryMaxInclusiveDynamic Defines a field that provide the maximum value allowed (including the maximum value) for this field.
boundaryMaxExclusiveDynamic Defines a field that provide the maximum value allowed (excluding the maximum value) for this field.
See also:

Content

This section can be deactivated on demand with the includeContent parameter (activated by default). It provides the content of the record values, dataset, or field of one of the content fields for an authorized user. It also has additional information, including labels, technical information, URLs...
The content is represented by a JSON Object with a property set for each sub-node.

Node value

JSON property
JSON format
Description
Required
content
Content of simple type
Content of group and list
Contains the node value. Available for all nodes except for association and selection. However, their content can be retrieved by invoking the URL provided in their details property.
No
details
String
corresponding to an absolute REST resource URL.
Returns the node details when invoked.
The response type depends on the meta type.
  • foreignKey: target record (available on table, record and field operations).
  • resource: target resource (available on dataset node, table, record and field operations).
  • association: target table containing the associated records (available on table and record operations).
  • selection: target table containing the associated records (available on table and record operations).
  • group: target dataset group node (available on dataset tree operation).
  • table: target table (available on dataset tree operation).
Example:
http://.../BReference/dataset/root/table/pk/associationField
No
historyDetails
String
corresponding to an absolute REST resource URL.
Returns the node history details when invoked.
See also:
No
label
String
Contains the foreign key or enumeration label in the current locale.
The default label is returned if the current locale is not supported.
No
inheritanceMode
String
Contains the node's inheritance state, considering only dataset inheritance. inheritedFieldMode and inheritanceMode properties cannot be both defined on the same node.
See also:
No
inheritedFieldMode
String
Contains the node's field inheritance state, considering dataset and field inheritance. When both inheritances are used, field inheritance has priority over the dataset one. inheritedFieldMode and inheritanceMode properties cannot be both defined on the same node.
See also:
No
selector
String
corresponding to an absolute URL.
Contains the appropriate URL for selector operation.
Example:
http://.../BReference/dataset/root/table/pk/enumField?selector=true
No
validation
Array
Contains the validation report that concerns the current node context.
See also:
No

Content of simple type

A simple field value is stored in a JSON Object and its content is the value of the content property.
See also:

Content of group and list

XML Schema
JSON format
Examples
Meta type
Group
xs:complexType
Object
Contains a property per sub-node.
Example for a simple-occurrence group. 
{

  "road": {

    "content": "11 rue scribe"

  },

  "zipcode": {

    "content": "75009"

  },

  "country": {

    "content": "France"

  }

}
group
List
maxOccurs > 1
Array
Contains an array of all field occurrences represented by a JSON Object.
Each object is represented as a node value.
Example for a multi-occurrence field of xs:int type. 
[

  {

    "content": 0

  },

  {

    "content": 1

  },

  {

    "content": 2

  },

  {

    "content": 3

  }

]
Example for a multi-occurrence group. 
[

  {

    "content": {

      "road": {

        "content": "11 rue scribe"

      },

      "zipcode": {

        "content": "75009"

      },

      "country": {

        "content": "France"

      }

    }

  },

  {

    "content": {

      "road": {

        "content": "711 Atlantic Ave"

      },

      "zipcode": {

        "content": "MA 02111"

      },

      "country": {

        "content": "United States"

      }

    }

  }

]
Meta of simple type,
or
group

Selector

By invoking the URL represented by the selector property on a field that provides an enumeration, it returns a JSON Object containing the following properties:
  • rows corresponding to an Array of JSON Object where each one contains two entries: the returned content that can be persisted and the corresponding label. The list of established possible items depends on the current context.
  • (Optional) pagination containing pagination data (activated by default).
    {
      "rows": [
        {
          "content": "F",
          "label": "feminine"
        },
        {
          "content": "M",
          "label": "masculine"
        }
      ],
      "pagination": {
        "firstPage": null,
        "nextPage": null,
        "previousPage": null,
        "lastPage": null
      }
    }
See also: