z/OS® ファイルの特定方式の要求

File Manager ファイルの特定方式の要求では、z/OS® Service Provider は次の JSON を受け入れます。

{
    "operation" :
    {
        "numRecords" : integer,
        "session" : boolean,
        "token"   : "string"
    },
    "position" :
    {
        "record" : integer,
        "key" : "string"
    }
}

特定方式の要求のキー・フィールドについて、次の表で説明します。


キー	説明
operation	operation パラメーターは、サービス・プロバイダーの動作に影響します。すべての operation パラメーターはオプションですが、パフォーマンス上の理由により、session および token パラメーターの正しい使用を理解するために役立ちます。
numRecords	取得するレコードの数。許容範囲は 0 から 10000 です。デフォルトは 1です。
session	File Manager セッションを継続するか終了するかを示します。値 true はセッションを開始し (まだ開始していない場合)、後続の API 呼び出しにもアクティブ状態を維持するようサービス・プロバイダーに指示します。値 false は API 呼び出しが完了したらセッションを終了するようサービス・プロバイダーに指示します。
token	以前の API 応答で返されるセッション・トークン。トークンはアクティブな File Manager セッションを表し、`"session" : true` を設定する初回読み取りに続く以降の読み取りに使用できます。`"session" : true` の初回読み取り要求が成功すると、応答でトークンが返されます。
position	position パラメーターは、データ・リソースの読み取り位置に影響します。相対的なレコード位置、またはキー位置 (KSDS の場合) にできます。
record	相対的なレコード読み取り位置。要求された場合、サービス・プロバイダーは指定された相対的なレコード位置に移動してからレコードを読み取ります。デフォルトは、初回読み取りの場合は 1 であり、後続の読み取りの場合は現在のレコード位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。
key	KSDS の場合のレコード・キー読み取り位置。要求された場合、サービス・プロバイダーは指定されたキー位置または次に高いキー位置に移動してからレコードを読み取ります。デフォルトは、初回読み取りの場合は最初のレコードであり、後続の読み取りの場合は現在のレコード位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。キー値はストリングとして表すことができます。例: `"ABC"`、 `"C'ABC DEF'"`、 `"X'C1F7'"`キー値にスペースまたは小文字が含まれる場合、`C'string'` フォーマットを使用する必要があります。 `key` パラメーターと `record` パラメーターは相互に排他的です。

データ・リソースを読み取る File Manager Service Provider のすべての初回要求 (つまりトークンを渡さない要求) には、次の形式の HTTP Basic 認証ヘッダーが必要です。

Authorization : Basic credentials_string

ここで、credentials_string は userid:password の Base64 エンコードを表します。例:

Authorization : Basic dXNlcmlkOnBhc3N3b3Jk