CMCI GET 要求 URI

オプション

/CICSSystemManagement

要求が CICS 管理クライアント・インターフェースにアクセスすることを示します。 CICSSystemManagement は大/小文字が区別されます。

resource_name

照会対象の CICS または CICSPlex SM リソースに関連付けられる外部リソース名を指定します。 例えば、リソース名 CICSRegion を指定すると、要求を CICSPlex SM CICSRGN リソースに関連付け、CICSResourceAssignmentDefinition を指定すると、要求を RASGNDEF リソースに関連付けます。 CICS 管理クライアント・インターフェース要求の外部リソース名の完全なリストについては、 CMCI リソース名 を参照してください。

HTTP GET メソッドは、すべてのリソースに対して有効であるわけではありません。 この HTTP メソッドが特定のリソースに対して有効であるかどうかを判別するには、 CICSPlex SM リソース・テーブルでリソースの説明を参照してください。

リソース名は大/小文字が区別されません。 正しくないリソース名がクライアントによって指定されると、HTTP 404 (Not Found) 応答が返されます。

コンテキスト

CMCI が CICSPlex SM 環境にインストールされている場合、context は、要求に関連付けられる CICSplex または CMAS の名前 (例えば PLEX1) です。 CICSplex と CMAS のどちらを指定するかを決定するには、 CICSPlex SM リソース・テーブル の関連リソース・テーブルを参照してください。

CMCI が単一サーバーとしてインストールされている場合、context は、要求に関連付けられる CICS 領域のアプリケーション ID です。

コンテキストの値にスペースを含めることはできません。 コンテキストは大/小文字が区別されません。

スコープ

照会に関連付けられた CICSplex、CICS グループ、CICS 領域、または論理的スコープの名前を指定します。 スコープはコンテキストのサブセットで、これにより、要求を特定の CICS システムまたはリソースに限定します。 スコープは必須ではありません。 スコープを省くと、要求はコンテキストのみの値で制限されます。 スコープの値にスペースを含めることはできません。 スコープは大/小文字が区別されません。

CICSResultCache/cache_token

保持された結果セットを格納する結果キャッシュを指定します。 キャッシュ・トークンを指定すると、要求を、前の GET 要求から保持されたレコードに制限します。 CMCI は各 CMCI 要求の完了時に、保存された結果セットの状況を確認します。 15 分以上未使用の状態だった結果セットは、cache_token と合わせて廃棄されます。

索引

保持された結果 (キャッシュ・トークン・パラメーターで指定) 内のレコードを特定します。 各レコードは、保持された結果セット内での位置によって識別されます。 indexは、1 から 2 147 483 647 の範囲 (両端を含む) の整数でなければなりません。 ゼロという値は許可されていません。 indexを指定しない場合、この位置にスラッシュを挿入する必要があります。

indexオプションを指定することで、要求されるレコードの数が変更されることはなく、またそれが警告カウント・メカニズムに影響することはありません。

count

結果キャッシュ内の 1 番目のレコードまたは index パラメーターで指定されたレコードから始まる、結果キャッシュ内にあるレコードのサブセットを特定します。 負の数値の場合、最終レコードから逆方向にカウントします。例えば、-1 は最終レコード、-2 は最後から 2 番目のレコードを表し、以降同様です。 count は、-2,147,483,647 から 2,147,483,647 まで (両端を含む) の範囲の整数でなければなりません。 ゼロという値は許可されていません。 リソース・パラメーターのケースでは、count の前に 2 本のスラッシュを付ける必要があります。

count オプションを指定すると、要求に対して表示されるレコードの数を制限することができます。要求されるレコードの数は変更されず、警告カウント・メカニズムには影響しません。

照会パラメーター

要求のスコープおよび特性を絞り込みます。 照会セクションの各構成要素を任意の順序で配置できますが、1 つの URI 内でそれぞれ 1 回だけ使用できます。 照会パラメーターはアンパーサンド (&) で区切られます。 照会パラメーター値には大/小文字の区別はありませんが、TRANID や DESC などの一部の属性は大/小文字混合の値を保持することができるため、特定の属性値は大文字を正しく使用する必要があります。 照会パラメーターは以下のとおりです。

CRITERIA=escaped_criteria_string

要求で返されるデータをフィルタリングする論理式のストリングです。 CRITERIA パラメーターの値を構成するストリングは、CICSPlex SM アプリケーション・プログラミング・インターフェースのフィルター式と同じ規則に従います。 CICSPlex SM API を使用したフィルター式の指定について詳しくは、 フィルター式の作成方法を参照してください。

特定の制限付き文字については、エスケープ・シーケンスで置換して、サーバーで正しく解釈されるようにする必要があります。 CICS 管理クライアント・インターフェース URI でのエスケープ・シーケンスの使用に関するガイダンスについては、 CMCI エスケープ・シーケンス を参照してください。

パラメーター =escaped_parameter_string

parameter_name(data_value) 形式の 1 つ以上のパラメーターおよび値からなるストリングで、要求を絞り込みます。 これらのパラメーターを指定する規則は、CICSPlex SM アプリケーション・プログラミング・インターフェースのものと同じです。 CICSPlex SM API を使用したパラメーター式の指定について詳しくは、 リソースに対するアクションの実行を参照してください。

特定の文字をエスケープ文字でエンコードする必要があります。 CICS 管理クライアント・インターフェース URI でのエスケープ・シーケンスの使用に関するガイダンスについては、 CMCI エスケープ・シーケンス を参照してください。

NODISCARD

要求の後、結果セットが保持されることを示します。 この属性は、値なしで指定します。 NODISCARD を指定しない場合、結果セットは破棄されます。 NODISCARD は、リソース名または保持されたキャッシュに作用する要求に対して使用できます。 CMCI は各要求の完了時に、保存された結果セットの状況を確認し、15 分以上未使用であったものを廃棄します。

ORDERBY

指定したフィールドによって結果セットがソートされることを示します。 この属性は論理式のストリングによって指定されます。ORDERBY パラメーターの値を構成するストリングは、CICSPlex SM アプリケーション・プログラミング・インターフェースの場合と同じ規則に従います。 EYUDA および CVDA 値の場合、フィールドは表示される文字値ではなく数値でソートされます。 CICSPlex SM API を使用してレコードをソートする方法について詳しくは、 結果セット内のレコードのソートを参照してください。

特定の文字をエスケープ文字でエンコードする必要があります。 CICS 管理クライアント・インターフェース URI でのエスケープ・シーケンスの使用に関するガイダンスについては、 CMCI エスケープ・シーケンス を参照してください。

このオプションを使用する各要求には、CICS によって自動的に管理される、L8 モード・オープン TCB および L9 モード・オープン TCB のプール内の L8 TCB が必要です。

OVERRIDEWARNINGCOUNT

警告カウント制限メカニズムをバイパスして、デフォルトの警告カウント制限が指定されていない場合と同様に要求を実行できるようにします。 このオプションが有効になるのは、CICSPlex SM Web ユーザー・インターフェースのサーバー初期設定パラメーター RESOURCELIMIT が WARNING に設定されている場合だけです。

SUMMONLY

要求で結果サマリーのみが返されることを意味します。 明細レコードは応答に含まれません。

SUMMONLY オプションを指定することで、要求に対してレコードは表示されなくなりますが、それによって要求されるレコードの数が変更されることはなく、またそれが警告カウント・メカニズムに影響することはありません。 SUMMONLY を含む要求は、要求されるレコードの数が警告カウント値を超えると失敗します。