z/OS® ファイルの特定方式の応答

成功時の応答では、HTTP ステータス・コード 200 が生成されます。失敗時には該当するステータス・コードと、失敗の原因を示すエラー・メッセージが生成されます。

File Manager サービス・プロバイダーは、特定方式の要求に対する応答で次の JSON 形式を生成します。
{
    "records" : 
    [
        {
            "last" : boolean,
            "layouts" : 
            {
                "layout-name" :
                {
                    "field1-name" : "value",
                    "field2-name" : "value",
                    "field3-name" : "value",
                    "fieldn-name" : "value"
                }
            }
        }
    ],
    "token" : "string"
}

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

キー 説明
records 0 以上のレコード・オブジェクトの配列。
last レコードがデータ・ソースの最後かどうかを示します。このキーは値が true の場合にのみ存在します。
layouts レコードに関連付けられた 1 つ以上の File Manager レイアウトの配列。
layout-name このキーは、File Manager テンプレートまたはコピーブックにあるレコード・レイアウトの名前です。値は、レイアウトに関連する 1 つ以上のフィールドを含むオブジェクトです。
field1-name …fieldn-name このキーは、データ・フィールドの名前です。値は、データ・フィールドの値です。
token File Manager セッション・トークン。要求が "session" : true に設定され、トークン値も渡さない場合にトークンが返されます。トークンは、File Manager 環境で実行されている z/OS® セッションを表し、クライアントによる複数の読み取りが必要な場合に後続の要求で使用できます。

File Manager セッションを終了するには、クライアントはトークンと "session" : false 付きの要求を送信する必要があります。そうしないと、非アクティブの場合に最終的にセッションはタイムアウトされます。