ビルトイン RESTful サービス

はじめに

使用されるアーキテクチャは ROA (Resource-Oriented Architecture) と呼ばれ、SOA (Service-Oriented Architecture) に代わるものと考えられます。選択したリソースは、リクエストのコンテンツに応じて、サードパーティのシステムで読み取りおよび書き込みが可能です。

ビルトイン RESTful サービスの HATEOAS アプローチにより、直感的で分かりやすいナビゲーションも可能になります。これは、リンクを介してデータの詳細を取得できることを意味します。

リクエスト

ここでは、HTTP メソッド、URL フォーマット、ヘッダーフィールド、メッセージ本文など、適合 REST リクエストを作成するために使用するエレメントについて説明します。

HTTP メソッド

ビルトイン RESTful サービスで考慮される HTTP メソッドは次のとおりです。

• GET：URL で定義されたマスターデータの選択に使用されます (URL のサイズ制限は、アプリケーションサーバーとブラウザーによって異なります。2KB 以下である必要があります)。

• POST：テーブルへのレコードの挿入、または URL で定義されたマスターデータの選択に使用されます (サイズ制限は 2MB 以上ですが、アプリケーションサーバーによって異なります。各パラメーターは、1024 バイトまでの値に制限されます)。

• PUT：URL で定義されたマスターデータの更新に使用されます。

• DELETE：URL で定義されたレコード、またはテーブル URL とメッセージ本文のレコードキーで定義された複数レコードのいずれかを削除するために使用されます。

URL

REST URL には次のものが含まれます。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/{categoryVersion}/{specificPath}[:{extendedAction}]?{queryParameters}

説明

• <ebx-dataservices> は、「ebx-dataservices.war」Web アプリケーションのパスに対応します。パスは、複数の URI セグメント (またはなし) と Web アプリケーションの名前の順序で構成されます。

• {category} は、操作カテゴリに対応します。

• {categoryVersion} は、カテゴリのバージョンに対応します。現在の値は v1 です。

• {specificPath} は、カテゴリ内の特定のパスに対応します。

• {extendedAction} は、拡張アクション名に対応します (オプション)。

• {queryParameters} は、URL で渡される共通または専用の操作パラメーターに対応します。

操作カテゴリ

操作を特定します。URL のパスの {category} に追加され、次のいずれかの値を指定します。

ヘッダーフィールド

これらのヘッダーフィールド定義は、TIBCO EBX® によって使用されます。

HTTP ヘッダーフィールド定義の詳細については、RFC2616 を参照してください。

共通パラメーター

これらのオプションのパラメーターは、すべてのデータサービス操作で使用できます。

メッセージ本文

JSON 形式を使用したリクエストデータが含まれています。拡張 JSON リクエスト本文およびコンパクト JSON リクエスト本文を参照してください。

応答

ここでは、ビルトイン RESTful サービスで返される応答について説明します。

• 標準エラー処理の詳細については、例外処理を参照してください (HTTP コードが 300 以上の場合)。

ヘッダーフィールド

これらのヘッダーフィールド定義は、EBX® によって使用されます。

HTTP コード

メッセージ本文

応答本文のコンテンツのフォーマットは、HTTP コード値によって異なります。

• 200 included から 300 excluded までの HTTP コード：コンテンツのフォーマットは、関連するリクエストによって異なります (拡張 JSON および コンパクト JSON のサンプル)。

  コード 204 (No content) は例外です。

• 300 以上の HTTP コード。コンテンツはエラーを説明しています。フォーマットの詳細については、JSON を参照してください。

管理操作

管理操作は以下に関連します。

• 管理カテゴリ。

• データカテゴリからアクセス可能な管理データスペース。

ディレクトリ操作

EBX® のデフォルトのディレクトリ構成は、ビルトイン RESTful サービスで管理できます。ユーザーとロールテーブル、メーリングリストおよびその他のオブジェクトが関係します。詳細については、ユーザーとロールのディレクトリを参照してください。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/data/v1/Bebx-directory/ebx-directory

ディレクトリ構成操作

EBX® のデフォルトのディレクトリ構成は、データセットノードのように管理できます。データカテゴリ操作を通じてアクセスおよび変更できます。各フィールドは、メタモデルが要求されたときに自己記述されます。

詳細については、Select 操作および Update 操作を参照してください。

メーリングリストの操作

EBX® ディレクトリに構成可能なデフォルトのメーリングリストは 2 つあります。1 つは全員用、もう 1 つは管理者用です。これらのリストは、データカテゴリ操作でデータセットノードと同様に扱うことができます。

詳細については、Select 操作および Update 操作を参照してください。

ディレクトリユーザー操作

ユーザーは、データ操作を使用して、データカテゴリのレコードと同様に操作できます。セキュリティ上の理由から、管理者は管理者自身を削除することはできません。ユーザーの敬称は、「敬称」テーブルで使用可能なものから選択する必要があります。

詳細については、Select 操作、Update 操作、Insert 操作、Delete 操作を参照してください。

ディレクトリロール操作

ロールは データ カテゴリのレコードであり、その操作で管理できます。 EBX® ロールは、「usersRoles」関連テーブルを通じてユーザーに割り当てられます。「usersRoles」は、ディレクトリがユーザーインターフェイスを介して管理されるときに自動的に供給されます。ただし、データサービスではそうではなく、ロールの割り当てには手動操作が必要です。ロールの包含は、「rolesInclusions」関連テーブルで指定されます。「usersRoles」テーブルに関しては、ロールの包含の管理には手動操作が必要です。メタモデルが要求されると、各テーブルは自己記述的です。

詳細については、Select 操作、Update 操作、Insert 操作、Delete 操作を参照してください。

ユーザーインターフェイスの操作

EBX® ユーザーインターフェイスは、保守の必要性に応じてユーザーに対して開くことも閉じることもできます。処理される情報は、[UI] タブの [管理] > [ユーザーインターフェイスの構成] > [詳細パースペクティブ] > [グラフィカルインターフェイスの構成] > [アプリケーションのロック] に含まれているものと同様です。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/data/v1/Bebx-manager/ebx-manager/domain/toolStatus

ユーザーインターフェイスの状態の取得

ユーザーインターフェイスのステータスと使用不可メッセージには、データセットノードと同様にアクセスできます。

詳細については、Select 操作および拡張 JSON またはコンパクト JSON の例を参照してください。

ユーザーインターフェイスを開くまたは閉じる

ユーザーインターフェイスのステータスと使用不可メッセージは、Update 操作を使用してデータセットノードと同様に変更できます。ユーザーインターフェイスを開く場合は、toolStatus のコンテンツを true に設定し、閉じる場合は false に設定します。

詳細については、Update 操作および拡張 JSON またはコンパクト JSON の例を参照してください。

システムの情報操作

この操作は、EBX® サーバー上のシステム情報を返します。これは、GET および POST HTTP メソッドで受け入れられます。警告：リクエスト本文が無視されるため、POST HTTP メソッドでは更新できません。返される情報は、ログヘッダー kernel.log または [UI] タブの [管理] > [システム情報] に含まれている情報と同じです。応答には、EBX® の構成とステータスを表すいくつかのキー、ラベル、および値が含まれます。応答の表示モードは、フラットにすることも階層にすることもできます。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/admin/v1/systemInformation

パラメーター

次のパラメーターが適用されます。

HTTP コード

応答本文

HTTP コードが 200 (OK) の場合にのみ返されます。コンテンツ構造は、指定されたパラメーター systemInformationMode またはそのデフォルト値によって異なります。

フラット表示の JSON の例を参照してください。

階層表示の JSON の例を参照してください。

トークン認証操作

これらの操作により、認証トークンを作成または取り消すことができます。認証トークンにはタイムアウト期間があります。この期間内にトークンを使用して EBX® サーバーにアクセスしなかった場合、トークンは自動的に取り消されます。このタイムアウト期間は、EBX® サーバーへのアクセスごとに更新されます。

トークンの作成操作

この操作では、ユーザーの資格情報と、オプションでセッションパラメーターを含むリクエストで POST HTTPメソッドを使用する必要があります。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/auth/v1/token:create

メッセージ本文

メッセージ本文は HTTP リクエストで定義する必要があります。必然的に、次のデータセットのいずれかが含まれます。

• login と password の値。両方の JSON 属性は必須で、文字列型です。

  詳細については、Directory.authenticateUserFromLoginPassword を参照してください。

• specific JSON 属性を true に設定します。このフラグを有効にすると、HTTP リクエスト全体に対してユーザー認証を実行できます。login および password 属性が JSON リクエストの本文で定義されている場合でも、Specific を true に設定すると、特定のユーザーの認証を有効にできます。

  詳細については、Directory.authenticateUserFromHttpRequest を参照してください。

トークン作成リクエストの JSON の例を参照してください。

HTTP コード

応答本文

HTTP コードが 200 (OK) の場合、本文はトークン値とそのタイプを保持します。

トークン作成応答の JSON の例を参照してください。

トークンは、後で HTTP-Header Authorization を適宜設定することにより、ユーザーを認証するために使用できます。

パスワード変更操作

この操作により、既存のユーザーアカウントのパスワードが変更されます。これは、認証済みコンテキストで使用できます。login パラメーターが存在する場合は現在のセッションに対して検証され、存在しない場合は現在のセッションから取得されます。また、未認証のコンテキストで使用することもできます。たとえば、トークンの作成操作が、HTTP コード 422 (Unprocessable entity) (原因：PasswordMustChange) で中止された場合などです。

以下を使用する必要があります。

• EBX® のデフォルトディレクトリ

• POST HTTP メソッド

• 以下に指定された構造を含むメッセージ本文

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/auth/v1/user:changePassword

メッセージ本文

メッセージ本文はリクエストで定義する必要があります。password と passwordNew が必須で、login はオプションです (すべて文字列)。

パスワードの変更とトークンの作成リクエストの JSON の例を参照してください。

HTTP コード

応答本文

HTTP コード 204 (No content) が返された場合は、パスワードが変更されています。

トークンの無効化操作

この操作では、POST HTTP メソッドを使用する必要があります。メッセージ本文は必要ありません。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/auth/v1/token:revoke

ヘッダーフィールド

> Authorization: <tokenType> <accessToken>

HTTP コード

データ操作

data カテゴリの操作は、データセット、データセットフィールド、テーブル、レコード、またはレコードフィールドに関係します。

data-compact カテゴリの操作は、データセットフィールド、テーブル、レコード、レコードフィールドに関係します。

data-bo カテゴリの操作は、ビジネスオブジェクトをナビゲートする機能を備えた data カテゴリの操作に関係します。

data-compact-bo カテゴリの操作は、ビジネスオブジェクトをナビゲートする機能を備えた data-compact カテゴリの操作に関係します。

history カテゴリの操作は、データセット、テーブル、レコード、またはレコードフィールドからの履歴コンテンツに関係します。

form-data カテゴリの操作は、コンテンツの作成または更新で制約を有効に保つ必要がある場合に、データセットフィールド、レコード、またはレコードフィールドに関係します。

form-data-compact カテゴリの操作は、コンテンツの作成または更新で制約を有効に保つ必要がある場合に、データセットフィールド、レコード、またはレコードフィールドに関係します。

詳細については、フォームデータ操作を参照してください。

Select 操作

Select 操作は、階層コンテンツを返します。この操作では、次のいずれかのメソッドを使用できます。

• GET HTTP メソッド

• POST HTTP メソッド (メッセージ本文なし)

• POST HTTP メソッド (メッセージ本文、:select、URL 拡張アクション。オプションでセッションパラメーターを含む)

URL フォーマットは次のとおりです。

• データセットツリー (操作カテゴリに基づく)

  data または data-compact カテゴリは、グループノードとテーブルノードを含む選択したデータセットの階層を返します。

  history カテゴリは、履歴テーブル ノードのみのプルーニングされたグループを含む、選択した履歴データセットの階層を返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}

  注意

  ターミナルノードとサブノードは含まれていません。

• データセットノード：data または data-compact カテゴリは、選択したノードに含まれるターミナルノードを返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}[:select]

  注意

  history カテゴリには適用されません。

• テーブル (操作カテゴリに基づく)

  data または data-compact カテゴリは、テーブルのコンテンツやメタモデル、現在のページレコード、およびページ付け用の URL を返します。

  history カテゴリは、履歴テーブルのコンテンツやメタモデル、現在のページレコード、およびページ付けの URL を返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}[:select]

  以下も参照してください。

  • Count 操作
  • ルックアップテーブルビュー操作

• レコード (操作カテゴリに基づく)

  data または data-compact カテゴリは、レコードのコンテンツやメタモデルを返します。

  history カテゴリは、履歴レコードのコンテンツおよび/またはメタモデルを返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}[:select]

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}[:select]?primaryKey={xpathExpression}

  注意

  主キー (primaryKey パラメーター) によるレコードアクセスは、そのルートノードに制限されています。この制限を無効にするために、details フィールドで利用可能なエンコードされた主キーを使用することをお勧めします。同様に、履歴レコードの場合は、historyDetails フィールドで使用可能なエンコードされた主キーを使用します。

• フィールド (操作カテゴリ に基づく)

  data または data-compact カテゴリは、フィールドレコードのコンテンツを返します。構造はそのタイプによって異なります。

  history カテゴリは、構造がそのタイプに依存するフィールド履歴レコードの内容を返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}/{pathInRecord}[:select]

  注意

  フィールドは、関連付けノード、選択ノード、ターミナルノード以上のいずれかである必要があります。

説明

• {category} は 操作カテゴリ に対応します (可能な値：data、data-compact、data-bo、data-bo-compact、または history)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、データセットノードのパスに対応します。データセットノードは、グループノードまたはテーブルノードの場合があります。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• {xpathExpression} は、XPath 式を使用して、レコードの主キーに対応します。

• {pathInRecord} は、テーブルノードから始まるパスに対応します。

• POST HTTP メソッドを本文メッセージで使用する場合は、:select 拡張アクションが必要です。

ビジネスオブジェクトカテゴリ (data-bo および data-compact-bo) は、その他のテーブルからデータを追加することで、テーブル、レコード、フィールドリクエストの応答を強化します。

• 1 対 1 関係は、応答の構造に直接含まれます。

• 1 対多関係は、HATEOAS リンクを通じてナビゲート可能になります。

パラメーター

次のパラメーターは、Select 操作に適用できます。

テーブルパラメーター

次のパラメーターは、テーブル、関連付け、および選択ノードに適用できます。

セレクターパラメーター

次のパラメーターは、列挙型、外部キー、または osd：resource を返すフィールドにのみ適用できます (例、JSON)。デフォルトでは、ページ機能は常に有効です。一部のセレクターの選択操作には、入力値が必要です。したがって、POST HTTP メソッドのメッセージ本文を使用してレコードコンテンツを提供できます。

HTTP コード

応答本文

データセット、テーブル、レコード、またはフィールドの選択が成功すると、結果が応答本文に返されます。内容は、提供されたパラメーターと選択されたデータによって異なります。

例：拡張 JSON、コンパクト JSON。

準備操作

作成または複製操作の準備は、初期コンテンツまたは複製するレコードのコンテンツを含む新しい一時レコードを作成するために使用されます。一時的なレコードは、まだ永続化されていないコンテンツに対応します。テーブルトリガーによって初期化されたデフォルト値とフィールドが考慮されます。少なくとも読み取り専用のアクセス権限を持つフィールド値のみが返されます。これらの操作は、オプションでメタデータを返し、クライアント側でのデータキャプチャを改善および支援できます。自動インクリメントされたフィールドは、メタデータでのみ返されます。セレクターパラメーターを有効にすることで、一時レコードのフィールドを照会して、列挙フィールドや外部キーなどの可能な値を取得できます。さらに、セレクターの Select 操作により、入力レコードデータを提供し、カスタムプログラム列挙でメタデータを取得するなど、使用を管理できます。

クライアント側で変更後、ビルトインのフォーム挿入操作または Insert 操作を使用して、レコードを永続化するために送信できます。

これらの準備操作では、次のいずれかのメソッドを使用できます。

• GET HTTP メソッド

• POST HTTP メソッド (メッセージ本文なし)

• POST HTTP メソッド (メッセージ本文あり)。オプションでセッションパラメーターを使用。

使用可能な URL フォーマットは次のとおりです。

• 作成の準備

  • レコード

    http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{tablePath}:prepareForCreation

  • レコードフィールド

    http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{tablePath}:prepareForCreation/{pathInRecord}

• 複製の準備

  • レコード

    http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{tablePath}/{encodedPrimaryKey}:prepareForDuplication

  • レコードフィールド

    http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{tablePath}/{encodedPrimaryKey}:prepareForDuplication/{pathInRecord}

説明

• {category} は操作カテゴリに対応します (使用可能な値は data または data-compact です)。

• {dataspace} は、B およびデータスペース識別子に対応します。

• {dataset} は、データセット識別子に対応します。

• {tablePath} はテーブルパスノードに対応します。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• {pathInRecord} は、テーブルノードから始まるパスに対応します。

パラメーター

次のパラメーターは、準備操作に適用できます。

セレクターパラメーター

使用可能なパラメーターは、セレクター操作のパラメーターと同様です。

HTTP コード

応答本文

作成または複製リクエストの準備が正常に完了すると、一時レコードが応答本文に返されます。内容は、提供されたパラメーターと選択されたデータによって異なります。ただし、選択操作レコードと類似のフォーマットを取ります。

例：拡張 JSON、コンパクト JSON。

Inset 操作

Insert 操作では、POST HTTP メソッドを使用します。データを指定するには、本文メッセージが必要です。この操作は、単一のトランザクションでの 1 つ以上のレコードの挿入をサポートします。さらに、パラメーター化によってレコードを更新することもできます。

• レコード：選択したテーブルに新しいレコードを挿入するか、既存のレコードを変更します。

• レコードテーブル：一貫した応答を確保しながら、選択したテーブルに 1 つ以上のレコードを挿入または変更します。操作は、クライアント側で定義された順序で順番に実行されます。テーブル操作中にエラーが発生すると、すべての更新がキャンセルされ、クライアントは詳細情報を含むエラーメッセージを受信します。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}[:mass]

説明

• {category} は操作カテゴリに対応します (使用可能な値は data または data-compact です)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、テーブルノードのパスに対応します。

• :mass 拡張アクションは、フィルター処理された一連のレコードを更新するときに必要です (filter パラメーターを参照)。

パラメーター

次のパラメーターは、Insert 操作に適用できます。

メッセージ本文

リクエストはメッセージ本文を定義する必要があります。フォーマットは、挿入されたオブジェクトタイプによって異なります。

• レコード：レコードの選択操作に似ていますが、レコードのヘッダーはありません (例：拡張 JSON、コンパクト JSON)。

• レコードテーブル：テーブルの選択操作に類似していますが、ページ情報はありません (例：拡張 JSON、コンパクト JSON)。

HTTP コード

応答本文

応答本文のフォーマットは、挿入されたオブジェクトタイプによって異なります。

• レコード：操作が正常に実行された場合は空です。ヘッダーフィールド Location は、その URL リソースとともに返されます。

• レコードテーブル：(オプション) Insert 操作レポートに対応するエレメントのテーブルが含まれます (例：JSON)。次のオプションの少なくとも 1 つが設定されている場合、このレポートは自動的に応答本文に含まれます。

  • includeForeignKey

  • includeLabel

  • includeDetails

Update 操作

この操作により、単一のデータセットまたはレコードを変更できます。PUT HTTP メソッドを使用する必要があります。使用可能な URL フォーマットは次のとおりです。

• データセットノード：選択したノードに含まれるターミナルノードの値を変更します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}

• レコード：選択したレコードのコンテンツを変更します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}

  注意

  POST HTTP メソッドでも使用できます。この場合、URL はテーブルを指す必要があり、パラメーター updateOrInsert は true に設定されている必要があります。

  注意

  updateOrInsert=true および byDelta=true パラメーターを指定して Insertoperation を使用して、複数のレコードのコンテンツを変更します。

• フィールド：選択したレコードの単一フィールドの更新。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}/{pathInRecord}

  注意

  フィールドは、ターミナルノード以上である必要があります。

説明

• {category} は操作カテゴリに対応します (使用可能な値は data または data-compact です)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、データセットノードのパスに対応します。

  • データセットノード操作の場合、これはテーブルノードを除く任意のターミナルノード以上である必要があります。

  • レコードおよびフィールド操作の場合、これはテーブルノードに対応します。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• {pathInRecord} は、テーブルノードから始まるパスに対応します。

パラメーター

更新操作に適用できるパラメーターは次のとおりです。

メッセージ本文

リクエストはメッセージ本文を定義する必要があります。

構造は次の場合は同一です。

• データセットノード (例：拡張 JSON、コンパクト JSON)

• レコード (例：拡張 JSON、コンパクト JSON)

• レコードフィールド (例：拡張 JSON、コンパクト JSON)

更新された範囲に応じて、content エントリのみを保持します。

HTTP コード

Delete 操作

この操作では、DELETE HTTP メソッドを使用します。

2 つの URL フォーマットを使用できます。

• レコード：URL で指定されたレコードを削除します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/data/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}

• レコードテーブル：一貫した応答を提供しながら、指定されたテーブル内の複数のレコードを削除します。このモードでは、レコードテーブルを含む本文メッセージが必要です。削除は、テーブルで定義された順序に従って順番に実行されます。テーブル操作中にエラーが発生すると、すべての削除がキャンセルされ、詳細情報を含むエラーメッセージが表示されます。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/data/v1/{dataspace}/{dataset}/{pathInDataset}[:mass]

説明

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、テーブルノードのパスに対応します。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• :mass 拡張アクションは、フィルター処理された一連のレコードを削除するときに必要です (filter パラメーターを参照)。

子データセットコンテキストでは、この操作により、レコードの inheritanceMode プロパティ値が次のように変更されます。

• 継承モードが inherit または overwrite に設定されているレコードは、occult になります。

• inheritIfInOccultingMode 操作パラメーターが true に設定されているか、未定義の場合、継承モードが occult に設定されているレコードは inherit になります、それ以外の場合は変更はありません。

• 継承モードが root に設定されているレコードは単純に削除されます。

ビジネスオブジェクトカテゴリ (data-bo および data-compact-bo) は、関連するすべてのレコードをカスケード削除します。ビジネスオブジェクト関係を通じて削除するレコードに追加します。

パラメーター

Delete 操作に適用できるパラメーターは次のとおりです。

メッセージ本文

filter または deleteAll クエリパラメーターを使用せずに複数のレコードを削除する場合にのみ、リクエストはメッセージ本文を定義する必要があります。

• レコードテーブル：メッセージには、レコードに関連するエレメントのテーブルが含まれ、エレメントごとに次のプロパティのいずれかが含まれます。

  • details：レコードの URL に対応し、選択操作によって返されます。

  • primaryKey：XPath 式を使用して、レコードの主キーに対応します。

  • externalKey：レコードを参照した場合に外部キーが持つ値に対応します。

  以下も参照してください。

  • primaryKey

  例：拡張 JSON、コンパクト JSON。

HTTP コード

応答本文

レコードの削除または非表示化が成功すると、応答本文にレポートが返されます。これには、削除、非表示化、継承されたレコードの数が含まれます。

JSON の例

Count 操作

Count 操作では、次のいずれかのメソッドを使用できます。

• GET HTTP メソッド

• POST HTTP メソッド (メッセージ本文なし)

• POST HTTP メソッド (メッセージ本文はあるがルートに content フィールドがない)

URL フォーマットは次のとおりです。

• データセットノード：data カテゴリは、選択したノードに含まれるターミナルノードの数を返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}:count

  注意

  history カテゴリには適用されません。

• テーブル (操作カテゴリに基づく)

  data カテゴリは、テーブルレコードの数を返します。

  history カテゴリは、テーブル履歴レコードの数を返します。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}:count

• 操作カテゴリに応じたフィールド

  data カテゴリは、レコードフィールドをカウントします。

  history カテゴリは、履歴レコードフィールドをカウントします。

  http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}/{pathInRecord}:count

  注意

  フィールドは、関連付けノード、選択ノード、ターミナルノード以上のいずれかである必要があります。

説明

• {category} は操作カテゴリに対応します (使用可能な値は data または data-compact です)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、データセットノードのパスに対応します。データセットノードは、グループノードまたはテーブルノードの場合があります。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• {pathInRecord} は、テーブルノードから始まるパスに対応します。

パラメーター

次のパラメーターは、Count 操作に適用できます。

テーブルパラメーター

次のパラメーターは、テーブル、関連付け、および選択ノードに適用できます。

セレクターパラメーター

次のパラメーターは、列挙型、外部キー、または osd:resource を返すフィールドにのみ適用できます。

HTTP コード

楽観ロック

以前に読み取られたが、その間に変更された可能性のあるレコードの Update または Delete 操作を回避するために、楽観ロックメカニズムが提供されます。

楽観ロックを有効にするには、Select リクエストで system 値を含む includeMetadata パラメーターを設定する必要があります。

詳細については、技術データを参照してください。

次のリクエストには、update_time プロパティ値を含める必要があります。指定した時間以降にレコードが変更された場合、Update または Delete 操作はキャンセルされます。

• レコード：選択したレコードのコンテンツ全体または一部を更新します。

  update_time 値をリクエスト本文に追加して、変更されたレコードが更新されないようにする必要があります。

  レコードの JSON の例を参照してください。

• フィールド：選択したレコードの単一フィールドの更新。

  update_time 値は、変更されたレコードの更新を防ぐために、checkNotChangedSinceLastUpdateTime パラメーターによってリクエスト URL で宣言する必要があります。

update_time プロパティの値をリクエスト URL の checkNotChangedSinceLastUpdateTime パラメーターで使用して、変更されたレコードが削除されないようにすることもできます。

継承

EBX® の継承機能は、特定のプロパティと自動動作を使用するビルトイン RESTful サービスによってサポートされます。ほとんどの場合、継承状態は、レコードとフィールドの定義またはコンテンツに従ってサーバーによって自動的に計算されます。レコードまたはフィールドを変更するすべてのアクションは、それらの状態に間接的な影響を与える可能性があります。継承のライフサイクルを完全に処理するために、特定の条件下で状態を直接変更することが許可されています。禁止または一貫性のない明示的な変更の試みは無視されます。

ビルトイン RESTful サービスでの継承ライフサイクル

継承プロパティ

下表は、EBX® の継承機能に関連するプロパティを示しています。

ルックアップテーブルビュー操作

「公開されたビューの検索」操作では、次のいずれかのメソッドを使用できます。

• GET HTTP メソッド

• POST HTTP メソッド (メッセージ本文なし)

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/data/v1/{dataspace}/{dataset}/{tablePath: [^:]*}:publishedViews

説明

• {dataspace} は、B とデータスペース識別子、または V と画像識別子 (この順序) に対応します。

• {dataset} は、データセット識別子に対応します。

• {tablePath: [^:]*} はテーブルパスに対応します。

パラメーター

この操作に特定のパラメーターはありません。

HTTP コード

応答本文

これには、許可されたビュー情報 (アクセス URI を含む) のコレクションが含まれています。

JSON の例

フォームデータ操作

フォームデータカテゴリの操作は、コンテンツの作成または変更がユーザーフォーム送信の制約に準拠する必要がある場合に、データセットフィールド、レコード、またはレコードフィールドに関係します。これらは、ユーザーフォーム管理コンテキストで使用することを目的としています。

操作のリクエスト本文は、受信データ検証機能と結果レポートが応答に追加されるという意味で、data カテゴリの同等の操作と非常によく似ています。データ検証を無効にすることはできず、data カテゴリ操作のパラメーター blockingConstraintsDisabled は適用されません。blocksCommit レベルが onInsertUpdateOrDelete または onUserSubmit-checkModifiedValues に設定された少なくとも 1 つの制約に違反すると、検証フェーズは失敗します。

詳細については、ブロッキングと非ブロッキングの制約を参照してください。

フォーム挿入操作

フォームの挿入では、POST HTTP メソッドを使用し、データを保持するメッセージ本文を必要が必要です。この操作は、単一トランザクション内の 1 つまたは複数のレコードをサポートします。また、レコードを更新することもできます。

• レコード：新しいレコードを検証して挿入するか、選択したテーブルの既存のレコードを変更します。

• レコードテーブル：一貫した応答を確保しながら、選択したテーブルの 1 つ以上のレコードを検証および挿入または変更します。操作は、クライアント側で定義された順序で実行されます。テーブル操作中にエラーが発生すると、すべての更新がキャンセルされ、クライアントは詳細情報を含むエラーメッセージを受け取ります。レコードの最大数は 100 に制限されています。

http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}[:mass]

説明

• {category} は操作カテゴリに対応します (可能な値は form-data または form-data-compact です)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、テーブルノードのパスに対応します。

• :mass 拡張アクションは、フィルター処理された一連のレコードを更新するときに必要です (filter パラメーターを参照)。

パラメーター

この挿入操作には、次のパラメーターが適用されます。

メッセージ本文

リクエストはメッセージ本文を定義する必要があります。フォーマットは、data カテゴリ Insert 操作のメッセージ本文に似ています。

HTTP コード

応答本文

応答本文は常に検証レポートを保持します。ただし、失敗した場合、応答本文は JSON 例外処理応答に対応します。

• レコード：ヘッダーフィールド Location が URL リソースとともに返されます。検証レポートは応答本文に含まれます。

• レコードテーブル：(オプション) 複数の検証レポートに対応する、各エレメントの検証レポートのリストが含まれます。

フォーム更新操作

data または data-compact カテゴリの Update 操作については、単一のデータセットまたはレコードの変更が可能であり、PUT HTTP メソッドを使用する必要があります。使用可能な URL フォーマットは次のとおりです。

• データセットノード：選択したノードに含まれるターミナルノードの値を検証および変更します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}

• レコード：選択したレコードのコンテンツを検証および変更します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}

  注意

  POST HTTP メソッドでも使用できます。この場合、URL はテーブルを指す必要があり、パラメーター updateOrInsert は true に設定されている必要があります。

• フィールド：選択したレコードの単一フィールドを検証および更新します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}/{pathInDataset}/{encodedPrimaryKey}/{pathInRecord}

  注意

  フィールドは、ターミナルノード以上である必要があります。

説明

• {category} は操作カテゴリに対応します (可能な値は form-data または form-data-compact です)。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、データセットノードのパスに対応します。

  • データセットノード操作の場合、これはテーブルノードを除く任意のターミナルノード以上である必要があります。

  • レコードおよびフィールド操作の場合、これはテーブルノードに対応します。

• {encodedPrimaryKey} は、主キーのパーセントエンコード表現に対応します (RFC-3986 Uniform Resource Identifier を参照)。

• {pathInRecord} は、テーブルノードから始まるパスに対応します。

パラメーター

更新操作に適用できるパラメーターは次のとおりです。

メッセージ本文

リクエストはメッセージ本文を定義する必要があります。フォーマットは、data カテゴリ更新操作メッセージ本文と同じです。

HTTP コード

応答本文

応答本文のフォーマットと動作は、フォーム挿入操作と同じです。

データセットの操作

これらの操作は、データセットに対して選択を実行します。

データセットの選択

選択操作では、GET メソッドまたは POST メソッドを使用できます。

URL フォーマットは次のとおりです。

• ルート：指定されたデータスペースのルートデータセットを返します。

  ページ付けメカニズムは常に有効になっています。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}

• 子：指定されたデータセットの子データセットを返します。

  ページ付けメカニズムは常に有効になっています。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}:children

• 情報：データセット情報を返します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/{category}/v1/{dataspace}/{dataset}:information

説明

• {category} は操作カテゴリに対応します (使用可能な値は data または data-compact です)。

• {dataspace} は、B の後にデータスペースの識別子が続くか、V の後にスナップショットの識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

パラメーター

次のクエリパラメーターは、ルート操作と 子操作に適用できます。

次のクエリパラメーターは、情報操作に適用できます。

HTTP コード

応答本文

選択の完了後、結果が応答本文に返されます。コンテンツは、指定されたパラメーターと選択されたデータによって異なります。

フォーマットは、選択したオブジェクトタイプにリンクされています。

• ルートと子については、拡張 JSON と 圧縮 JSON の例を参照してください。

• 情報については、拡張 JSON と コンパクト JSON の例を参照してください。

データスペース操作

これらの操作は、データスペースの選択またはライフサイクル管理を実行します。

ベータ機能：データスペースまたはスナップショットの選択

Select 操作では、GET または POST のいずれかのメソッドを使用できます。ページ付けメカニズムは常に有効になっています。

URL フォーマットは次のとおりです。

• ルート：ルートデータスペースを返します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/data/v1/

• 子：指定されたデータスペースの子データスペースを返します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/data/v1/{dataspace}:children

• スナップショット：指定されたデータスペースのスナップショットを返します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/data/v1/{dataspace}:snapshots

• 情報：データスペースまたはスナップショットの情報を返します。

  http[s]://<host>[:<port>]/ebx-dataservices/rest/data/v1/{dataspace}:information

説明

• {dataspace} は、B の後にデータスペースの識別子が続くか、V の後にスナップショットの識別子が続くことに対応します。

パラメーター

次のクエリパラメーターは、ルート、子、およびスナップショットの操作に適用できます。

HTTP コード

応答本文

選択の完了後、結果が応答本文に返されます。コンテンツは、指定されたパラメーターと選択されたデータによって異なります。

フォーマットは、選択したオブジェクトタイプにリンクされています。

• ルート、子、またはスナップショットについては、JSON の例を参照してください。

• 情報については、JSON の例を参照してください。

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

指定されたとおりにデータスペースまたはスナップショットを作成します。この操作では、本文リクエストで POST メソッドを使用します (特定のクエリパラメーターはありません)。

URL フォーマットは次のとおりです。

• データスペース

  http[s]://<host>[:<port>]/.../data/v1/{dataspace}:createDataspace

• スナップショット

  http[s]://<host>[:<port>]/.../data/v1/{dataspace}:createSnapshot

説明

• {dataspace} は、B およびデータスペース識別子に対応します。

リクエスト本文

本文は、作成するデータスペースまたはスナップショットの機能を指定します。

JSON の例を参照してください。

HTTP コード

ベータ機能：データスペースのロック

指定されたデータスペースをロックします。データスペースがすでにロックされている場合、次のことが適用されます。

• 同一ユーザーによるロックでは、ロックが保持されます。

• 別のユーザーによるロックで待機期間中の場合、ロックが取得されます。

• それ以外の場合、ロックは拒否されます。

この操作は POST メソッドを使用し、次のように設定された Content-Type ヘッダーを使用します。

• application/x-www-form-urlencoded：本文に HTTP パラメーターを使用します。

• application/json：URL に HTTP パラメーター、JSON 本文にセッションパラメーターを使用します。

成功した場合、応答本文は返されません。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../data/v1/{dataspace}:lock

説明

• {dataspace} は、B およびデータスペース識別子に対応します。

パラメーター

次のクエリパラメーターが操作に適用されます。

HTTP コード

ベータ機能：データスペースのロック解除

指定されたデータスペースのロックを解除します。データスペースの状態により、次のことが適用されます。

• 同一ユーザーによるロックでは、ロックが解除されます。

• 別のユーザーによるロックでは、現在のユーザーが管理者であり、forceByAdministrator クエリパラメーターが true に設定されている場合、ロックが解除されます。

• ロックされていない場合、ロックステータスは変更されません。

• それ以外の場合、ロック解除は拒否されます。

この操作は POST メソッドを使用し、次のように設定された Content-Type ヘッダーを使用します。

• application/x-www-form-urlencoded：本文に HTTP パラメーターを使用します。

• application/json：URL に HTTP パラメーター、JSON 本文にセッションパラメーターを使用します。

成功した場合、応答本文は返されません。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../data/v1/{dataspace}:unlock

説明

• {dataspace} は、B およびデータスペース識別子に対応します。

パラメーター

次のクエリパラメーターが操作に適用されます。

HTTP コード

ベータ機能：データスペースのマージ

指定されたデータスペースをその親にマージします。マージ後、履歴やデータに対して削除を実行することができます。

この操作は POST メソッドを使用し、次のように設定された Content-Type ヘッダーを使用します。

• application/x-www-form-urlencoded：本文に HTTP パラメーターを使用します。

• application/json：URL に HTTP パラメーター、JSON 本文にセッションパラメーターを使用します。

成功した場合、応答本文は返されません。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../data/v1/{dataspace}:merge

説明

• {dataspace} は、B およびデータスペース識別子に対応します。

パラメーター

次のクエリパラメーターが操作に適用されます。

HTTP コード

ベータ機能：データスペースまたはスナップショットを閉じる

指定されたデータスペースまたはスナップショットを閉じます。閉じた後、履歴および/またはデータに対して削除を実行することができます。

この操作は POST メソッドを使用し、次のように設定された Content-Type ヘッダーを使用します。

• application/x-www-form-urlencoded：本文に HTTP パラメーターを使用します。

• application/json：URL に HTTP パラメーター、JSON 本文にセッションパラメーターを使用します。

成功した場合、応答本文は返されません。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../data/v1/{dataspace}:close

説明

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

パラメーター

次のクエリパラメーターが操作に適用されます。

HTTP コード

ヘルスオペレーション

概要

オペレーションの正常性は、EBX® サーバーの監視に役立ちます。

運用開始

EBX® が開始されて初期化されている場合はステータスコード 200 (OK) を返し、それ以外の場合は 503 (Service unavailable) を返します。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../health/v1/started

HTTP コード

応答本文

JSON の例を参照してください。

動作確認

EBX® が開始されて確認された場合はステータスコード 200 (OK) を返し、それ以外の場合は 503 (Service unavailable) を返します。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../health/v1/check

HTTP コード

応答本文

JSON の例を参照してください。

運用停止

EBX® リポジトリがシャットダウンされている場合は、ステータスコード 200 (OK) を返し、それ以外の場合は 503 (Service unavailable) を返します。

URL フォーマットは次のとおりです。

http[s]://<host>[:<port>]/.../health/v1/stopped

HTTP コード

応答本文

JSON の例を参照してください。

OpenAPI 操作

概要

api カテゴリの操作は、OpenAPI 仕様 3.0.X に準拠して JSON ドキュメントを生成します。これらのドキュメントは、使用可能な REST ビルトインリソースとそれらに関連付けられた操作を構造化して記述することにより、開発と使用を容易にします。

includeOpenApiDetails クエリパラメーターを使用すると、データの選択操作を通じて OpenAPI ドキュメントの HATEOAS リンクを利用できます。

REST OpenAPI サービスの権限は、グローバル許可でグローバルに定義されています。

特定の言語でクライアントを生成するための適切な型マッピングを作成することが不可欠です。OpenAPI 形式を使用して、選択したプログラミング言語で、入力を検証したり、値を特定の型にマッピングしたりできます。詳細については、単純型のコンテンツを参照してください。

OpenAPI ドキュメントの生成

この操作では、GET または POST HTTP メソッドを使用して、データセット、テーブル、またはスキーマノードの OpenAPI ドキュメントを生成します。

URL フォーマットは次のとおりです。

• データセット

  http[s]://<host>[:<port>]/ebx-dataservices/rest/api/v1/{category}/v1/{dataspace}/{dataset}

• テーブルとスキーマノード

  http[s]://<host>[:<port>]/ebx-dataservices/rest/api/v1/{category}/v1/{dataspace}/{dataset}/{pathInDataset}

説明

• {category} は、data、data-compact、または form-data 操作カテゴリに対応します。

• {dataspace} は、B の後にデータスペース識別子が続くか、V の後にスナップショット識別子が続くことに対応します。

• {dataset} は、データセット識別子に対応します。

• {pathInDataset} は、次のパスに対応します。

  • テーブルノード

  • データセットターミナルノードまたはそれ以上

HTTP コード

ステージングオペレーション

ステージング REST API は、ソースサーバーとターゲットサーバーと対話するように設計されています。ユーザーは、ステージングアーカイブのエクスポートとインポートを使用してドメインを管理できます。

サービスの完全な説明は、次のリンクの OpenAPI を介して入手できます。

http[s]://<host>[:<port>]/ebx-dataservices/rest/api/v1/staging/v1

開発実行モードでは、次のリンクから Swagger UI を利用できます。

http[s]://<host>[:<port>]/ebx-dataservices/rest/api/v1/staging/v1/ui

ドメイン管理操作

domains サービスにより、ユーザーはドメインを管理できます。提供される機能は次のとおりです。

• 利用可能なドメインのリストを選択します。

• 一意の名前でドメインを選択します。

• 新しいドメインを作成します。

• ドメインのコンポーネントを選択します。

• コンポーネントをドメインに追加します。

• ドメインからコンポーネントを削除すると、コンポーネントが削除されます。

ステージングエレメントのナビゲーション操作

elements サービスは、インスタンスのエレメント全体を階層的に表示するように設計されています。これは主に、レベルを処理する階層ビューをサポートする UI インターフェイス用に設計されています。構造化された本文の代わりにクエリパラメーターを使用する目的は、リンクを使用してナビゲーションを容易にすることです。提供される機能は次のとおりです。

• エレメントのコンテンツを展開します。

• 選択したエレメントの下にある特定の種類のエレメントのコンテンツを展開します。

アーカイブ操作

archives サービスは、単一のリクエストで実行中のインスタンスとの間でステージングアーカイブをインポート/エクスポートするように設計されています。また、非同期インポート用のアーカイブのアップロードにも使用されます。提供される機能は次のとおりです。

• ドメインのアーカイブをエクスポートします。

• 実行中のインスタンスにアーカイブをインポートします。

• 非同期インポート用のアーカイブをアップロードします。

cURL 経由でステージングアーカイブをエクスポートする最も簡単な方法

curl --request GET 'http[s]://<host>[:<port>]/ebx-dataservices/rest/staging/v1/archives/<domain>?login=<login>&password=<password>'

cURL 経由でステージングアーカイブをインポートする最も簡単な方法

curl --request POST 'http[s]://<host>[:<port>]/ebx-dataservices/rest/staging/v1/archives?login=<login>&password=<password>'
--header 'Content-Type: application/zip'
--data-binary '@/<archive-path-on-disk>'

エクスポート操作

exports サービスは、高度なエクスポート機能を処理するように設計されています。アーカイブはエクスポートされ、事前に定義された期間、サーバーに保存されます。ユーザーはアーカイブに関する情報を取得でき、有効期限が切れるまでダウンロードできます。提供される機能は次のとおりです。

• エクスポートを開始します。

• 開始されたエクスポートのステータスを取得します。

• エクスポートされたアーカイブをダウンロードします。

このエンドポイントは、同期モードと非同期モードの両方で機能します。

同期モード

サーバー上のアーカイブ全体をエクスポートした後に応答するブロッキングモード。アーカイブはすぐにダウンロードできます。

非同期モード

エクスポート ID で応答し、アーカイブをエクスポートするタスクを起動する非ブロッキングモード。クライアントは、ステータスエンドポイントをポーリングして、エクスポートのステータスを取得する必要があります。ステータスが「エクスポート済み」に変わると、アーカイブはダウンロード可能になります。

一貫性を保つために、ステージング非同期ジョブは、60 分以内に完了しない場合は中止されます。

インポート操作

imports サービスは、高度なインポート機能を処理するように設計されています。アーカイブはアップロードされ、事前に定義された期間サーバーに保存されます。ユーザーは、インポートを非同期的に開始したり、進行中または完了したインポートに関する情報を取得したりできます。

アーカイブは、オプション asyncImport=true を指定した archives サービスを使用してアップロードされます。

提供される機能は次のとおりです。

• アップロード済みのアーカイブを使用してインポートを開始します。

• 開始されたインポートのステータス/レポートを取得します。

古いインポートからアーカイブ名を取得して、異なるオプションで同じアーカイブの再インポートを開始できます。有効期限が切れるまで利用できます。

このエンドポイントは非同期モードでのみ機能します。

制限事項

一般的な制限事項

• リクエスト URL {pathInDataset} または {pathInRecord} のインデックスはサポートされていません。

• データセットノードおよびサブターミナルのノードに適用されるフィールド操作はサポートされません。

  ターミナルノードの詳細については、アクセスプロパティを参照してください。

コンパクト形式の制限事項

• 継承、追跡情報、セッションパラメーター、およびプロシージャコンテキストは、コンパクト形式で処理されません。代わりに拡張形式を使用してください。

• 履歴カテゴリは、コンパクト形式ではサポートされません。

ビジネスオブジェクトカテゴリの制限事項

• ビジネスオブジェクトカテゴリ：並べ替え、フィルタ、および履歴選択機能は、ビジネスオブジェクトで定義された関係下のフィールドには適用できません。

読み取り操作

• セレクター内では、ページ付けコンテキストは nextPage プロパティに制限されています。

• sortByRelevancy パラメーターがアクティブな場合、sort、sortOnLabel、sortPriority、および viewPublication で定義された並べ替え基準パラメーターは無視されます。

• viewPublication パラメーター内では、階層ビューとタイルビューはサポートされていません。

• sortOnLabel パラメーターは、プログラムによるラベルを無視します。

• システム情報応答のプロパティは、階層表示を使用して REST URL で参照することはできません。

  詳細については、システム情報の操作を参照してください。

• 作成の準備操作は、データセットノードをサポートしていません。

• データスペースの Select 操作では、ラベルで並べ替えられません。

• スナップショットの Select 操作では、スナップショットは作成日で並べ替えられません。

• スナップショットの Select 操作に初期スナップショットを含めることはできません。

書き込み操作

• 関連付けフィールドは更新できないため、関連付けられたレコードのリストを直接変更することはできません。

• ユーザーインターフェイスの制御ポリシー onUserSubmit-checkModifiedValues はサポートされていません。検証エラーを取得するには、includeValidation パラメーターを含めて、リソースで Select 操作を呼び出します。

  詳細については、ブロッキングと非ブロッキングの制約を参照してください。

ディレクトリ操作

• ユーザーのパスワードの変更またはリセットはサポートされていません。

OpenAPI 操作

• ドキュメントの生成は、ユーザーインターフェイスからは利用できません。

• ドキュメント生成 REST サービスは YAML フォーマットをサポートしていません。

• 以下を除いて、データ操作とフォームデータ操作のみをサポートします。

  • データセットツリー、データセットノード、フィールドの選択操作。

  • 1 回のリクエストで複数のレコードを挿入または削除します。

  • HTTP ヘッダー content-type: x-www-form-urlencoded を使用して、本文リクエストでクエリパラメーターを送信します。

• 「基本認証スキーム」は、説明されている唯一の方法です。