Cloud Software Group, Inc. EBX®

Documentation > Developer Guide > REST data services > JSON Formats

Navigation modeDocumentation > Developer Guide > REST data services > JSON Formats

Others

Introduction
Global structure
- JSON Request body
- JSON Response body

Introduction

The Extended and Compact JSON formats can handle most of the use cases, however some operations and REST categories require specific formats like the followings.

Global structure

JSON Request body

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

Auth category

The request body holds several properties directly placed in the root JSON Object.

Token creation
Specifies the login and password to use for an authentication token creation attempt.
```
{
  "login": "...",                  // JSON String
  "password": "..."                // JSON String
}
```
Specifies the specific attribute, to activate the user authentication against the HTTP request, for an authentication token creation attempt.
```
{
  "specific": true                 // JSON Boolean
}
```
See also
- Create token operation

Password change

Specifies the login, password and passwordNew to use for the password change.

{
  "login": "...",            // JSON String
  "password": "...",         // JSON String
  "passwordNew": "..."       // JSON String
}

JSON Response body

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

Admin category

The selection operation for this category only provides the requested values under a content property.

System information

Contains EBX® instance's system information. The representation of these data can be flat or hierarchical.

Flat representation:

{
  "content": {
    "bootInfoEBX": {
      "label": "EBX® configuration",
      "content": {
        "product.version": {
          "label": "EBX® product version",
          "content": "5.8.1 [...] Enterprise Edition"
        },
        "product.configuration.file": {
          "label": "EBX® main configuration file",
          "content": "System property [ebx.properties=./ebx.properties]"
        },
        // others keys
      }
    },
    "repositoryInfo": {
      "label": "Repository information",
      "content": {
        "repository.identity": {
          "label": "Repository identity",
          "content": "00905A5753FD"
        },
        "repository.label": {
          "label": "Repository label",
          "content": "My repository"
        },
        // others keys
      }
    },
    "bootInfoVM": {
      "label": "System information",
      "content": {
        "java.home": {
          "label": "Java installation directory",
          "content": "C:\\JTools\\jdk1.8.0\\jre"
        },
        "java.vendor": {
          "label": "Java vendor",
          "content": "Oracle Corporation"
        },
        // others keys
      }
    }
  }
}

Hierarchical representation:

{
  "content": {
    "bootInfoEBX": {
      "label": "EBX® configuration",
      "content": {
        "product": {
          "content": {
            "version": {
              "label": "EBX® product version",
              "content": "5.8.1 [...] Enterprise Edition"
            },
            "configuration": {
              "content": {
                "file": {
                  "label": "EBX® main configuration file",
                  "content": "System property [ebx.properties=./ebx.properties]"
                }
              }
            }
          }
        },
        "vm": {
          "content": {
            "startTime": {
              "label": "VM start time",
              "content": "2017/09/11-10:04:17-0729 CEST"
            },
            "identifier": {
              "label": "VM identifier",
              "content": "1"
            }
          }
        },
        // other hierarchical keys
      }
    }
  }
}

Auth category

The response body contains several properties directly placed in the root JSON Object.

Token creation

Contains the token value and its type.

{
  "accessToken": "...",            // JSON String
  "tokenType": "..."               // JSON String
}

Data category

Look up table views

The response body contains a content property holding a JSON Array, itself composed by JSON Objects with the following properties:

JSON property	JSON format	Description	Required
`details`	`String`	Corresponds to the view access URL.	Yes
`label`	`String`	View's label.	No
`viewPublication`	`String`	Published view's name. See also Table `viewPublication` parameter	Yes
`viewType`	`String`	Enumeration whose value corresponds to one of the following: `SimpleTabular`: Simple tabular view. `Hierarchy`: Hierarchical view. `Tile`: Tile view.	Yes

{
  "content": [
    {
      "details": "http://.../data/v1/Bebx-directory/ebx-directory/directory/users?viewPublication=custom-directory",
      "label": "My custom directory view",
      "viewPublication": "custom-directory",
      "viewType": "SimpleTabular"
    },
    {
      ...
    }
  ]
}

Beta feature: Dataspaces selection

The returned response body contains dataspaces in a rows JSON Array property, where each inner JSON Object corresponds to a dataspace with the following properties:

JSON property	JSON format	Description	Required
`label`	`String`	Documentation label in the current locale.	No
`description`	`String`	Documentation description in the current locale.	No
`details`	`String`	Specifies the dataspace's REST resource URL.	Yes
`information`	`String`	Specifies the dataspace's information REST resource URL.	Yes
`key`	`String`	Specifies the dataspace or snapshot formatted key. Format: `[BV][a-zA-Z0-9_:.\-\\|]{1,33}` and percent encoded afterward.	Yes
`isSelectAllowed`	`Boolean`	Specifies if the dataspace can be selected, according to the user's permissions.	Yes
`hasChildren`	`Boolean`	Specifies if the dataspace has children, according to the user's permissions. Note Not applicable for snapshots.	Yes
`children`	`String`	Specifies the dataspace's children REST resource URL. If `hasChildren` property key value is `false` then the returned value is `null`. Note Not applicable for snapshots.	No
`snapshots`	`String`	Specifies the dataspace's snapshots REST resource URL. Note Not applicable for snapshots.	Yes

{
  "rows": [
    {
      "label": "Master Data - Reference",
      "description": "Reference dataspace in EBX.",
      "details": "http://.../data/v1/BReference",
      "information": "http://.../data/v1/BReference:information",
      "key": "BReference",
      "closed": false,
      "isSelectAllowed": true,
      "hasChildren": true,
      "children": "http://.../data/v1/BReference:children",
      "snapshots": "http://.../data/v1/BReference:snapshots"
    },
    {
      // An other dataspace
    }
  ],
  "pagination": {
    "firstPage": null,
    "previousPage": null,
    "nextPage": null,
    "lastPage": null
  }
}

Beta feature: Dataspace information

The response body contains a content JSON Object property, holding the following properties:

JSON property	JSON format	Description	Required
`content`	`Object`	Corresponds to the dataspace or the snapshot information.	Yes
`key`	`String`	Specifies the dataspace or snapshot formatted key value. Format: `[BV][a-zA-Z0-9_:.\-\\|]+` limited to 33 characters maximum.	Yes
`documentation`	`Array` of JSON `Object`	Corresponds to the localized documentation with a JSON `Object` by locale.	No
`locale`	`String`	Documentation locale (nested under the `documentation` property).	Yes
`label`	`String`	Documentation label (nested under the `documentation` property).	No
`description`	`String`	Documentation description (nested under the `documentation` property).	No
`closed`	`Boolean`	Specifies if the dataspace is closed.	Yes
`locked`	`Boolean`	Specifies if the dataspace is locked. Note Not applicable for snapshots.	Yes
`parent`	`String`	Specifies the parent dataspace or snapshot formatted key value.	No
`administration`	`Boolean`	Specifies if the dataspace or the snapshot is an administration one.	Yes
`owner`	`String`	Specifies the owner profile.	No
`creator`	`String`	Specifies the creator profile.	Yes
`creationDate`	`Date`	Specifies the creation date.	Yes

{
  "content": {
    "key": "BReference",
    "documentation": [
      {
        "locale": "en-US",
        "label": "Master Data - Reference",
        "description": "Reference dataspace in EBX."
      },
      {
        "locale": "fr-FR",
        "label": "Données - Référence",
        "description": "Espace de données référence de EBX."
      }
    ],
    "closed": false,
    "locked": false,
    "parent": null,
    "administration": false,
    "relationalMode": false,
    "owner": "Badministrator",
    "creator": "Badministrator",
    "creationDate": "2019-04-28T19:49:04.838"
  }
}

Beta feature: Dataspace child or snapshot creation

The response body contains a content JSON Object property, holding the following properties:

JSON property	JSON format	Description	Required
`key`	`String`	Specifies the dataspace or snapshot formatted key value. Format: `[BV][a-zA-Z0-9_:.\-\\|]+` limited to 33 characters maximum. The default value is a timestamp.	No
`owner`	`String`	Specifies the owner profile. Default value is `null`.	No
`documentation`	`Array` of JSON `Object`	Corresponds to the localized documentation with a JSON `Object` by locale. Default value is `null`.	No
`locale`	`String`	Documentation locale (nested under the `documentation` property).	Yes
`label`	`String`	Documentation label (nested under the `documentation` property). Default value is `null`.	No
`description`	`String`	Documentation description (nested under the `documentation` property). Default value is `null`.	No
`dataspaceKeyToCopyPermissionsFrom`	`String`	Specifies the dataspace's formatted key value from which to copy permissions. Note Not applicable for snapshots creation.	No

{
  "content": {
    "key": "BMyData",
    "owner": "Beveryone",
    "documentation": [
      {
        "locale": "en-US",
        "label": "My dataspace",
        "description": "This space contains my data"
      }
    ],
    "dataspaceKeyToCopyPermissionsFrom": "BReference"
  }
}

Health category

Health started and check responses

The response body contains a JSON String value corresponding to an OK value.

Health stopped response

The response body contains a JSON String value corresponding to an enumeration value. Possible values: OK or NO

Documentation > Developer Guide > REST data services > JSON Formats

TIBCO EBX® Version 6.2.0. Copyright © 2001-2024. Cloud Software Group, Inc. All rights reserved.

All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Others

Introduction

Global structure

JSON Request body

Auth category

See also

See also

JSON Response body

Admin category

See also

Auth category

See also

Data category

Look up table views

See also

See also

Beta feature: Dataspaces selection

Note

Note

Note

See also

Beta feature: Dataspace information

Note

See also

Beta feature: Dataspace child or snapshot creation

Note

See also

Health category

Health started and check responses

Health stopped response