Méthode system_variable[]

Retourne la valeur d'une variable de système HCL.

Syntaxe

hcl.system_variable["nom_variable"]

Paramètres

Nom Description
nom_variable

Le nom de la variable système HCL.

À l'heure actuelle, trois variables système HCL sont disponibles pour être utilisées dans les scripts Python/HCL :

Nom de variable Description
environment La variable est automatiquement affectée au mode (environnement) dans lequel le script est exécuté. La valeur variable peut être soit development, soit production.
organization_id La variable est automatiquement affectée à l'ID de l'organisation Diligent One dans laquelle le script est exécuté.
hb_api_host La variable est automatiquement affectée à l'URL de base de l'API HighBond pour l'organisation Diligent One dans laquelle le script est exécuté.

Valeurs renvoyées

Chaîne.

Exemples

Retourner la valeur d'une variable système HCL

Retourne development, qui est la valeur de la variable système HCL environment.

hcl.system_variable["environment"]

Retourne 11594, qui est la valeur de la variable système HCL organization_id.

hcl.system_variable["organization_id"]

Retourne https://apis-us.highbond.com, qui est la valeur de la variable système HCL hb_api_host.

hcl.system_variable["hb_api_host"]

Remarques

Pour plus d'informations, consultez la section Utiliser des variables dans un script Python/HCL.