Others

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
  }

  See also

  • Change password operation

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
        }
      }
    }
  }

  See also

  • System information operation

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
  }

  See also

  • Create token operation

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:

{
  "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:

{
  "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:

{
  "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:

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