その他

最終公開日 : Aug 10, 2026
Related information

はじめに

拡張および コンパクト JSON 形式はほとんどのユースケースを処理できますが、一部の操作と REST カテゴリには次のような特定の形式が必要です。

グローバル構造

JSON リクエスト本文

リクエストの本文は JSON オブジェクトで表され、その内容は操作とカテゴリによって異なります。

認証カテゴリ

リクエスト本文には、ルート JSON オブジェクトに直接配置されたいくつかのプロパティが含まれています。
  • トークンの作成
    認証トークンの作成試行に使用する login と password を指定します。

    {
      "login": "...",                  // JSON String
      "password": "..."                // JSON String
    }
    specific 属性を指定して、認証トークンの作成を試行するために、HTTP リクエストに対してユーザー認証をアクティブにします。

    {
      "specific": true                 // JSON Boolean
    }
    以下も参照してください。:
  • パスワードの変更
    パスワードの変更に使用する login、 password、および passwordNew を指定します。

    {
      "login": "...",            // JSON String
      "password": "...",         // JSON String
      "passwordNew": "..."       // JSON String
    }
    以下も参照してください。:

JSON 応答本文

応答の本文は JSON オブジェクトで表され、その内容は操作とカテゴリによって異なります。

管理者カテゴリ

このカテゴリの Select 操作では、 content プロパティで要求された値のみが提供されます。
  • システム情報
    EBX® インスタンスのシステム情報が含まれています。これらのデータの表現は、フラットまたは階層的です。
    フラット表現

    {
      "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
          }
        }
      }
    }
    階層表現

    {
      "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
          }
        }
      }
    }
    以下も参照してください。:

認証カテゴリ

応答本文には、ルートJSON オブジェクトに直接配置されたいくつかのプロパティが含まれています。
  • トークンの作成
    トークン値とそのタイプが含まれます。

    {
      "accessToken": "...",            // JSON String
      "tokenType": "..."               // JSON String
    }
    以下も参照してください。:

データカテゴリ

テーブルビューの検索

応答の本文には、JSON Array を保持する content プロパティが含まれています。このプロパティ自体は、次のプロパティを持つ JSON オブジェクトで構成されています。
JSON プロパティ
JSON 形式
説明
必須
details
String
ビューアクセス URL に対応します。
はい
label
String
ビューのラベル。
いいえ
viewPublication
String
公開されたビューの名前。
以下も参照してください。:
はい
viewType
String
値が次のいずれかに対応する列挙。
  • SimpleTabular：単純な表形式のビュー。
  • Hierarchy：階層ビュー。
  • Tile：タイルビュー。
はい

{
  "content": [
    {
      "details": "http://.../data/v1/Bebx-directory/ebx-directory/directory/users?viewPublication=custom-directory",
      "label": "My custom directory view",
      "viewPublication": "custom-directory",
      "viewType": "SimpleTabular"
    },
    {
      ...
    }
  ]
}
以下も参照してください。:

ベータ機能：データスペースの選択

返される応答本文には、 rows JSON Array プロパティにデータスペースが含まれます。ここで、各内部JSON オブジェクトは、次のプロパティを持つデータスペースに対応します。
JSON プロパティ
JSON 形式
説明
必須
label
String
現在のロケールのドキュメントラベル。
いいえ
description
String
現在のロケールでのドキュメントの説明。
いいえ
details
String
データスペースの REST リソース URL を指定します。
はい
information
String
データスペースの情報 REST リソース URL を指定します。
はい
key
String
データスペースまたはスナップショット形式のキーを指定します。
フォーマット：[BV][a-zA-Z0-9_:.\-\|]{1,33} およびその後にエンコードされたパーセント。
はい
isSelectAllowed
Boolean
ユーザーの権限に従って、データスペースを選択できるかどうかを指定します。
はい
hasChildren
Boolean
ユーザーの権限に従って、データスペースに子があるかどうかを指定します。
注意:
スナップショットには適用されません。
はい
children
String
データスペースの子 REST リソース URL を指定します。hasChildren プロパティキーの値が false の場合、戻り値は null です。
注意:
スナップショットには適用されません。
いいえ
snapshots
String
データスペースのスナップショット REST リソース URL を指定します。
注意:
スナップショットには適用されません。
はい

{
  "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
  }
}
以下も参照してください。:

ベータ機能：データスペース情報

応答本文には、次のプロパティを保持する content JSON オブジェクトプロパティが含まれています。
JSON プロパティ
JSON 形式
説明
必須
content
Object
データスペースまたはスナップショット情報に対応します。
はい
key
String
データスペースまたはスナップショット形式のキー値を指定します。
形式：[BV][a-zA-Z0-9_:.\-\|]+ 。最大 33 文字に制限されています。
はい
documentation
JSON オブジェクトの Array
ロケールごとに JSON オブジェクトを使用してローカライズされたドキュメントに対応します。
いいえ
locale
String
ドキュメントロケール (documentationプロパティの下にネストされています)。
はい
label
String
ドキュメントラベル (documentation プロパティの下にネストされています)。
いいえ
description
String
ドキュメントの説明 (documentationプロパティの下にネストされています)。
いいえ
locked
Boolean
データスペースを閉じるかどうかを指定します。
はい
locked
Boolean
データスペースをロックするかどうかを指定します。
注意:
スナップショットには適用されません。
はい
paranet
String
親データスペースまたはスナップショット形式のキー値を指定します。
いいえ
administration
Boolean
データスペースまたはスナップショットが管理用のものであるかどうかを指定します。
はい
owner
String
所有者プロファイルを指定します。
いいえ
creator
String
作成者プロファイルを指定します。
はい
creationDate
Date
作成日を指定します。
はい

{
  "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"
  }
}
以下も参照してください。:

ベータ機能：データスペースの子またはスナップショットの作成

応答本文には、次のプロパティを保持する content JSON オブジェクトプロパティが含まれています。
JSON プロパティ
JSON 形式
説明
必須
key
String
データスペースまたはスナップショット形式のキー値を指定します。
形式：[BV][a-zA-Z0-9_:.\-\|]+ 。最大 33 文字に制限されています。
デフォルト値はタイムスタンプです。
いいえ
owner
String
所有者プロファイルを指定します。
デフォルト値は null です。
いいえ
documentation
JSON オブジェクトの Array
ロケールごとに JSON オブジェクトを使用してローカライズされたドキュメントに対応します。
デフォルト値は null です。
いいえ
locale
String
ドキュメントロケール (documentationプロパティの下にネストされています)。
はい
label
String
ドキュメントラベル (documentation プロパティの下にネストされています)。
デフォルト値は null です。
いいえ
description
String
ドキュメントの説明 (documentationプロパティの下にネストされています)。
デフォルト値は null です。
いいえ
dataspaceKeyToCopyPermissionsFrom
String
権限のコピー元となるデータスペース形式のキー値を指定します。
注意:
スナップショットの作成には適用されません。
いいえ

{
  "content": {
    "key": "BMyData",
    "owner": "Beveryone",
    "documentation": [
      {
        "locale": "en-US",
        "label": "My dataspace",
        "description": "This space contains my data"
      }
    ],
    "dataspaceKeyToCopyPermissionsFrom": "BReference"
  }
}
以下も参照してください。:

ヘルスカテゴリ

正常性および応答の確認

応答本文には、 OK 値に対応する JSON 文字列値が含まれています。

ヘルス停止応答

応答本文には、列挙値に対応する JSON 文字列値が含まれています。可能な値： OK または NO。