汎用方式の応答: IMS

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

File Manager データの正常な汎用方式の要求への応答で、IMS Service Provider は次の JSON フォーマットを生成します。

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

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

キー 説明
segments IMS データ・リソースからの 0 以上のセグメントの配列。
last 指定されている場合、そのセグメントが IMS リソースの最後にあることを示します。
layout このセグメントをマップするために使用されたセグメント・レイアウトの名前。
segname IMS データベース・セグメントの名前。
fields 各セグメントは、1 つ以上のフィールドの配列として表されます。
field レイアウト・フィールドの名前。
type フィールドの File Manager データ・タイプ。データ・タイプのリストについては、「Dynamic Template (動的テンプレート)」パネルを参照してください。
dimension フィールドが配列の場合、配列の次元。例えば、2 の値は 2 次元配列を表します。
value データ・フィールドの値。NULL 値は、値を判別できないことを示します。
error フィールド値が NULL である理由 (つまり、値を判別できない理由) を説明する短いエラー・テキスト。
token File Manager セッション・トークン。要求が "session" : true に設定され、トークン値も渡さない場合にトークンが返されます。トークンは、File Manager/IMS 環境で実行されている z/OS® セッションを表し、クライアントによる複数のアクセスが必要な場合に後続の要求で使用できます。

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