図 6 は、情報カタログ・マネージャーの API 入力構造の一般的な形式を示しています。 この構造は、ヘッダー域、定義域、およびオブジェクト域という 3 つの連続する 区域からなります。 情報カタログ・マネージャー API 呼び出しによっては、最初の 2 つの区域だけしか必要としないものもあります。
各区域のフィールドについては、以下のセクションで説明します。
![]() |
以下の API 呼び出しは入力構造から入力を受け取ります。
FLGSearch および FLGSearchAll は、入力構造を受け取らなかった場合には、すべての オブジェクトの検索を試みます。
ヘッダー域では、定義域とオブジェクト域の情報を記述します。 必須でないフィールドで値を指定しないものは、ブランクにセットしなければなりません。
![]() |
表 7 は、図 7 で示したヘッダー域の
各バイト・オフセット位置の意味を示しています。
図 7 で示したセクション | バイト・オフセット | 必須かどうか | 説明 |
---|---|---|---|
FLG-HEAD | 0-7 | 常に必須 | 構造の識別子。 |
定義の長さ | 8-15 | 常に必須 | 定義域の長さ。
この値は、160 の倍数 (160 に定義レコードの数を掛けた値) でなければならない。 |
オブジェクトの長さ | 16-23 | 常に必須 | オブジェクト域の長さ。
FLGAppendType および FLGCreateType の場合、この値はゼロ (00000000) である。 |
オブジェクト域の項目カウント | 24-31 | 常に必須 | オブジェクト域内の項目 (特性値) の数。
この値は、定義域内の特性の数にオブジェクト域で記述された 値のセットの数を掛けた値になる。
FLGAppendType および FLGCreateType の場合、この値はゼロ (00000000) である。 |
区分 | 32 | 以下の場合には必須
| オブジェクト・タイプまたはオブジェクトの区分
有効な値は以下のとおり。
|
オブジェクト・タイプの ID | 33-38 | 以下の場合には必須
| オブジェクト・タイプに関するシステム生成された識別子。 |
| 39-159 | 常に必須 | ブランクのままにする必要がある。 |
定義域には、特定の情報カタログ・マネージャー API 機能の入力パラメーターとして必要な 特性定義の集合が入ります。
表 8 は、入力構造を使用する各種の API 呼び出しにとって、
定義域に入っている情報がどのような意味を持つのかを示しています。
API 呼び出し | 定義域で示される情報 |
---|---|
FLGAppendType FLGCreateInst FLGCreateReg FLGCreateType FLGUpdateInst FLGUpdateReg | オブジェクト登録、オブジェクト・タイプ、またはオブジェクト・インスタンス を定義する特性の集合の定義。 |
FLGSearch FLGSearchAll | 選択基準を記述する特性の集合の定義。 |
FLGExport | エクスポートされるメタデータを指定する特性の定義。 |
FLGManageCommentStatus | Comments 状況選択項目を指定する特性の集合の定義。 |
FLGManageUsers | 情報カタログ・マネージャー・ユーザーを記述する特性の集合の定義。 |
定義域内の各特性は、形式設定された仕様の集合によって定義されます。表 9 は、図 8 で示されたバイト・オフセット位置を説明しています。
![]() |
図 8 で示したセクション | バイト・オフセット | 必須かどうか | 説明 |
---|---|---|---|
特性名 | 0-79 | 常に必須 | 特性の外部名。 |
データ・タイプ | 80-109 | 常に必須 | 特性のデータ・タイプ。
有効な値は以下のとおり。
|
長さ | 110-117 | 常に必須 | 特性値の最大長。 |
ppn | 118-125 | 以下の場合には必須
| 特性省略名 |
vf | 126 | 以下の場合には必須
| 特性が必須であるのか、任意選択であるのか、あるいはシステム生成される
のかを指定する値フラグ。
有効な値は以下のとおり。
|
us | 127 | 以下の API 呼び出しでは必須
| 汎用固有識別コード (UUI) の順序番号を指定。
これにより、ある特性がその UUI のパートであることが示される。
有効な値は以下のとおり。
どのオブジェクト・タイプについても、UUI のパート 1 として少なくとも 1 つは 特性を指定しなければならない。
UUI のパートの定義の詳細については、情報カタログ・マネージャー 管理の手引き を参照。 |
cs | 128 | 以下の API 呼び出しでは必須
| 大文字小文字の区別フラグ。
有効な値は以下のとおり。
大文字小文字の区別フラグについては、FLGSearchおよび FLGSearchAllを参照。 |
fs | 129 | 以下の API 呼び出しでは必須
| ファジー探索フラグ。
有効な値は以下のとおり。
ファジー探索フラグについては、 FLGSearchおよび FLGSearchAllを参照。 |
| 130-159 | 常に必須 | 予約セクション。
ブランクのままにする必要がある。 |
オブジェクト域には、定義域で定義された特性の値が入ります。 これらの値は、定義域で定義したとおりの順序で指定する必要があります。
入力構造のオブジェクト域には、FLGExport および FLGManageUsers 以外のすべて の API の定義域で定義された各定義について 1 つずつしか値が入りません。 FLGExport および FLGManageUsers の場合のオブジェクト域には、定義域で 定義された各特性について 1 つ以上の値を含めることができます。
オブジェクト域は、以下の API 呼び出しでは必須です。
それぞれの値を表現する方法は、以下の規則によって判別することができます。