system_variable[] メソッド

HCL システム変数の値を返します。

構文

hcl.system_variable["変数名"]

パラメーター

名前 説明
変数名

HCL システム変数の名前。

現在、Python/HCL スクリプトでは次の 3 つの HCL システム変数を使用できます。

変数名 説明
environment この変数は、スクリプトを実行するモード（環境）に自動的に割り当てられます。変数の値は、development または production のいずれかになります。
organization_id この変数は、スクリプトを実行する Diligent One 組織の ID に自動的に割り当てられます。
hb_api_host この変数は、スクリプトを実行する Diligent One 組織の HighBond API ベース URL に自動的に割り当てられます。

戻り値

文字列。

例

HCL システム変数の値を返す

environment HCL システム変数の値である development を返します。

hcl.system_variable["environment"]

organization_id HCL システム変数の値である 11594 を返します。

hcl.system_variable["organization_id"]

hb_api_host HCL システム変数の値である https://apis-us.highbond.com を返します。

hcl.system_variable["hb_api_host"]

備考

詳細については、「Python/HCL スクリプトの変数の使用」を参照してください。