特定方式の要求: IMS™
File Manager データの特定方式の要求では、 IMS™ Service Provider は次の JSON を受け入れます。
{
"operation" :
{
"numSegments" : integer,
"session" : Boolean,
"token" : "string"
},
"position" :
{
"segmentKeys" :
[
{
"segmentName" : "string",
"keyValue" : "string",
"operator" : "string"
}
]
}
}
特定方式の要求のキー・フィールドについて、次の表で説明します。
| キー | 説明 |
|---|---|
| operation | operation パラメーターは、サービス・プロバイダーの動作に影響します。すべての operation パラメーターはオプションですが、パフォーマンス上の理由により、session および token パラメーターの正しい使用を理解するために役立ちます。 |
| numSegments | 取得するデータベース・セグメントの数。許容範囲は 0 から 10000 です。デフォルトは 1です。 |
| session | File Manager/IMS セッションを継続するか終了するかを示します。値 true はセッションを開始し (まだ開始していない場合)、後続の API 呼び出しにもアクティブ状態を維持するようサービス・プロバイダーに指示します。値 false は API 呼び出しが完了したらセッションを終了するようサービス・プロバイダーに指示します。 |
| token | 以前の API 応答で返されるセッション・トークン。トークンはアクティブな FM/IMS セッションを表し、"session" : true を設定する初回読み取りに続く以降の読み取りに使用できます。"session" : true の初回読み取り要求が成功すると、応答でトークンが返されます。 |
| position | position パラメーターは、IMS™ データベース内の読み取り位置に影響します。位置設定では、関連するデータベース・セグメントの名前とそのセグメントまでの階層パス、およびセグメント・キーの長さが判明している必要があります。位置設定は、読み取り要求が満たされる前に実行されます。 |
| segmentKeys | データベース・セグメント名と関連するキー値の配列。データベースの階層順で配列エレメントを指定します。配列にリストされる最後のセグメントが、位置設定先のセグメントとなるので注意してください。 |
| segmentName | 位置設定先またはその後のデータベース・セグメントの名前。 |
| keyValue | 位置設定先またはその後のセグメントのキーの必須値。 |
| operator | segmentKeys 配列内のセグメント/キー値エレメントに基づき位置設定するための論理演算子。operator には EQ (等しい) または GE (以上) を指定できます。デフォルトは、EQ です。 operator パラメーターは、segmentKeys 配列の最後のエレメント (つまり、位置設定先のセグメント) に対して指定した場合にのみ有効ですが、配列で指定されているすべてのセグメント/キー値割り当てに対して適用されます。
|