例 11: IMS™ データベースを順次読み取る

name=fmExample11
description=IFB2:HDOU#1 MAPPED BY MY.IMS.VIEW(HDOU#1)
version=1.0
provider=filemanager
host=10.1.1.2
port=9043
userid=admin
passwd=s3cr3t
ssid=IFB2
database=HDOU#1
regionType=DLI
view=MY.IMS.VIEW(HDOU#1)
timeout=300
connid=default

初回要求

IMS™ データ・リソースからデータを読み取る初回 API 呼び出しには、IMS™ データ・リソースへの以降のアクセスで呼び出し元を認証できるように、HTTP Basic 認証ヘッダーが必要です。例:

Authorization : Basic dXNlcmlkOnBhc3N3b3Jk

ここで、Basic キーワードに続くストリングは、userid:password の Base64 エンコードを示します。

また、JSON ペイロードがあるすべての要求でも、値が application/json の Content-Type ヘッダーが必要です。

初回要求では、データ・リソースに命名したり、ビュー情報を指定したりする必要はありません。この情報は API に関連付けられたサービス・アーカイブに既に含まれています。このため、API 呼び出し元が指定する必要があるのは、必要に応じて、オプションの operation パラメーターと position パラメーターのみです。

{
    "operation" : 
    {
        "numSegments" : 1,
        "session" : true
    }
}

この要求では、IMS™ ビューによるフィルターに従い FM/IMS データベースの先頭から 1 セグメントが読み取られます。すべてのセグメント読み取りは、ビューによる応答でマップされます。

File Manager/IMS が true に設定されているため、サービス・プロバイダーは session セッションを維持します。セッションは、以降、session が false に設定された要求が実行されるまで、またはセッションでアクティビティーがない状態で 300 秒 (5 分) のタイムアウト期間が経過するまでアクティブのままになります。このタイムアウト期間はサービス・アーカイブで事前設定されています。

session が true に設定されている場合、呼び出し元は初回要求でトークンが戻ることを期待し、Basic 認証ヘッダーを渡す必要なく後続の呼び出しでトークンを使用できます。

成功時の応答

成功時の応答 (HTTP ステータス・コード 200) は次のようになります。

{
    "segments": 
    [
        {
            "PARTROOT": 
            {
                "PARTROOT": 
                {
                    "ROOT-KEY": "3009280",
                    "ROOT-SPACES": " ",
                    "ROOT-TYPE": "02",
                    "ROOT-WOSNAME": "HOUSING CONV"
                }
            }
        }
    ],
    "token": "/u5qZ/hg8fX18fH29Pjz9WD39fnw8/k="
}

{
    "operation" :
    {
        "numSegments" : 1,
        "session" : true,
        "token": "/u5qZ/hg8fX18fH29Pjz9WD39fnw8/k="
    }
}

{
    "segments" :
    [
        {
            "last" : true,
    … other response fields
        }
    ]
}

{
    "operation" :
    {
        "numSegments" : 0,
        "session" : false,
        "token": "/u5qZ/hg8fX18fH29Pjz9WD39fnw8/k="
    }
}