z/OS® ファイルの汎用方式の応答

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

File Manager z/OS ファイルにアクセスするための正常な汎用方式の要求への応答で、Service Provider は次の JSON フォーマットを生成します。

{
    "records" : 
    [
        {
            "last" : boolean,
            "layouts" : 
            [
                {
                    "layout" : "string",
                    "fields" : 
                    [
                        {
                            "field" : "string",
                            "type" : "string",
                            "dimension" : integer,
                            "value" : "string-number-array-or-null",
                            "error" : "string"
                        }
                    ]
                }
            ]
        }
    ] ,
    "token" : "string"
}

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

キー 説明
records 0 以上のレコード・オブジェクトの配列。
last レコードがデータ・ソースの最後かどうかを示します。このキーは値が true の場合にのみ存在します。
layouts レコードに関連付けられた 1 つ以上の File Manager レイアウトの配列。
layout File Manager テンプレートまたはコピーブックにあるレコード・レイアウトの名前。
fields レイアウト内の 1 つ以上のデータ・フィールドの配列。
field データ・フィールドの名前。データ・ソースへの接続時にテンプレートやコピーブックが指定されなかった場合、DATA の名前が使用されます。
type フィールドの File Manager データ・タイプ。データ・タイプのリストについては、「Dynamic Template (動的テンプレート)」パネルを参照してください。
dimension フィールドが配列の場合、配列の次元。例えば、2 の値は 2 次元配列を表します。このキーは、データ・フィールドが配列である場合にのみ存在します。
value データ・フィールドの値。ストリング、数字、配列、NULL のいずれかです。NULL 値は、値を判別できず、エラーのキーと値のペアが生成されることを示します。
error フィールド値が NULL である理由を説明する短いエラー・テキスト。例:
  • フィールドがレコードの最後を越えてマップされている。
  • フィールドが切り捨てられている。
  • フィールドにデータ・タイプと一致する形式のデータが含まれていない。
token File Manager セッション・トークン。要求が "session" : true に設定され、トークン値も渡さない場合にトークンが返されます。トークンは、File Manager 環境で実行されている z/OS® セッションを表し、クライアントによる複数の読み取りが必要な場合に後続の要求で使用できます。

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