z/OS® ファイルの汎用方式の要求

汎用方式の要求で File Manager ファイルにアクセスするために、z/OS® Service Provider は次の JSON を受け入れます。

{
    "resource" :
    {
        "resourceName" : "string",
        "volser" : "string",
        "dataCcsid" : number,
        "dbcsCcsid" : number,
    },
    "template" :
    {
        "templateName" : "string",
        "tmplCcsid" : number,
        "copybookName" : "string",
        "language" : "string",
        "options" : "string"
    },
    "operation" :
    {
        "numRecords" : integer,
        "session" : boolean,
        "token"   : "string"
        "timeout" : number
    },
    "position" :
    {
        "record" : integer,
        "key" : "string"
    }
}

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

キー 説明
resource データ・リソースに関連付けられたパラメーター。resource パラメーターは、データ・リソースからの単一または初回の読み取りを実行するときにのみ必要です。トークンが渡されるときの後続の読み取り要求では resource パラメーターは必要ありません。
resourceName データ・リソースの名前。例: MVS.DATASET, /uss/data.dat, FI:APPLID:CICSFILE, TD:APPLID:CICSTDQ, TS:APPLID:CICSTSQ, MQ:QMGR:QNAME

ここで、APPLID はターゲットの CICS 領域のアプリケーション ID を表し、QMGR は MQ システムを表します。
volser データ・リソースのボリューム通し番号 (該当する場合)。
dataCcsid リソース英数字データの CCSID。デフォルト値は 037 です。
dbcsCcsid グラフィックまたは 2 バイト・データの CCSID。デフォルト値は 930 です。これは dataCcsid と同じである可能性があり、GRAPHIC および DBCS フィールドをサポートするために必要になります。
template template パラメーターはデータ・リソースをマップし、File Manager テンプレートまたはコピーブックにできます。template パラメーターは、データ・リソースからの単一または初回の読み取りを実行するときにのみ必要です。トークンが渡されるときの後続の読み取り要求では template パラメーターは必要ありません。
templateName データ・リソースをマップする File Manager テンプレートの名前。例: MVS.DATASET(TEMPLATE)。
tmplCcsid テンプレートまたはコピーブックの CCSID。デフォルト値は 037 です。
copybookName データ・リソースをマップするコピーブックの名前。コピーブックは、File Manager テンプレートではなくデータ・リソースをマップするために使用できます。
language コピーブックの言語。COBOL、PLI、HLASM、または AUTO のいずれかです。コピーブックの言語が COBOL または PLI の場合、AUTO を使用できます。
options コピーブックのコンパイル・オプション。コピーブックを使用してデータをマップするために、File Manager はコピーブックをコンパイルしてフィールド・オフセットを特定します。一部の状況では、これらのオフセットを正確に特定するために、特別なコンパイラー・オプションが必要になります。この目的のために options パラメーターを使用できます。以下のオプションがサポートされています。
  • COBOL:

    DBCS=、CDPC=、CAE=、MIXED=、CBLMAXRC=、RFROMn=、RTOn=

  • PLI:

    BIN63=、DEC31=、GRAPHIC=、UNALIGNED=、PLIMAXRC=、PLILIBS=

  • HLASM:

    DBCS=、NOALIGN=、ASMMAXRC=、ASMLIBS=

サポートされるオプションについて詳しくは、File Manager 機能 を参照してください。

複数のオプションをコンマで区切って指定できます。language パラメーターが指定されていない場合、options パラメーターは無視されます。
operation operation パラメーターは、サービス・プロバイダーの動作に影響します。すべての operation パラメーターはオプションですが、パフォーマンス上の理由により、session および token パラメーターの正しい使用を理解するために役立ちます。
numRecords 取得するレコードの数。許容範囲は 0 から 10000 です。デフォルトは 1です。
session File Manager セッションを継続するか終了するかを示します。値 true はセッションを開始し (まだ開始していない場合)、後続の API 呼び出しにもアクティブ状態を維持するようサービス・プロバイダーに指示します。値 false は API 呼び出しが完了したらセッションを終了するようサービス・プロバイダーに指示します。
token 以前の API 応答で返されるセッション・トークン。トークンはアクティブな File Manager セッションを表し、"session" : true を設定する初回読み取りに続く以降の読み取りに使用できます。"session" : true の初回読み取り要求が成功すると、応答でトークンが返されます。
timeout File Manager 表示セッションを終了する前に非アクティブにできる時間 (秒)。0 から 28800 (8 時間) までの任意の値を指定できます。デフォルトは 300 (5 分) です。

この値が server.xml 構成の max_timeout より大きい場合、timeout 値は無視され、max_timeout 値が代わりに使用されます。
position position パラメーターは、データ・リソースの読み取り位置に影響します。相対的なレコード位置、またはキー位置 (KSDS の場合) にできます。
record 相対的なレコード読み取り位置。要求された場合、サービス・プロバイダーは指定された相対的なレコード位置に移動してからレコードを読み取ります。デフォルトは、初回読み取りの場合は 1 であり、後続の読み取りの場合は現在のレコード位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。
key KSDS の場合のレコード・キー読み取り位置。要求された場合、サービス・プロバイダーは指定されたキー位置または次に高いキー位置に移動してからレコードを読み取ります。デフォルトは、初回読み取りの場合は最初のレコードであり、後続の読み取りの場合は現在のレコード位置です。有効なトークンが渡される場合、読み取りは後続の読み取りとみなされます。

キー値はストリングとして表すことができます。例: "ABC"、"C'ABC DEF'"、"X'C1F7'"。キー値にスペースまたは小文字が含まれる場合、C'string' フォーマットを使用する必要があります。

key パラメーターと record パラメーターは相互に排他的です。