User macroオブジェクト

次のオブジェクトは、usermacroAPIに直接関連しています。

Global macro

global macro オブジェクトには次のプロパティがあります。

プロパティ	タイプ	説明
globalmacroid	string	(読取専用) グローバルマクロのID。
macro (必須)	string	マクロ文字列
value (必須)	string	マクロの値
type	integer	マクロのタイプ有効な値: 0 - (デフォルト) テキストマクロ 1 - シークレットマクロ 2 - Vault シークレット
description	string	マクロの説明

Host macro

host macro objectはホスト、ホストプロトタイプ、またはテンプレートで使用可能なマクロを定義します。次のプロパティがあります。

プロパティ	タイプ	説明
hostmacroid	string	(読取専用) ホストマクロのID
hostid (必須)	string	マクロが属するホストのID
macro (必須)	string	マクロ文字列
value (必須)	string	マクロの値
type	integer	マクロのタイプ有効な値: 0 - (デフォルト) テキストマクロ 1 - シークレットマクロ 2 - Vault シークレット
description	string	マクロの説明

マクロ設定

マクロ設定オブジェクトは、ホストウィザードにおけるマクロの表示方法を定義します。

プロパティ	タイプ	説明
type	integer	マクロ入力フィールドのタイプ。有効な値: 0 - ホストウィザードでマクロを使用しない。 1 - テキストボックス。 2 - リスト。 3 - チェックボックス。プロパティの動作: - 必須
label	文字列	マクロ入力フィールドのラベル。プロパティの動作: - `type` が"テキストボックス"、"リスト"、または"チェックボックス"に設定されている場合、必須です。
description	テキスト	マクロ入力フィールドの横に表示されるヘルプテキスト。Markdown フォーマットをサポートしています。
priority	整数	マクロリスト内のマクロ入力フィールドの位置。 `priority` が設定されていない場合、マクロはグループ化されていないマクロリストの末尾に追加されます。
required	整数	マクロを必須としてマークします。有効な値: 0 - 必須ではありません。 1 - 必須です。プロパティの動作: - `type` が "Textbox" または "List" に設定されている場合にサポートされます。
regex	文字列	テキストボックスフィールドへのユーザー入力を検証するための正規表現です。プロパティの動作: - `type` が "Textbox" に設定されている場合にサポートされます。
section_name	文字列	マクロがグループ化されている折りたたみ可能なセクションのラベルです。 `section_name` が設定されていない場合、マクロはグループ化されていません。グループ化されていないマクロが最初に表示されます。グループ化されたマクロは、各折りたたみ可能なセクション内で `priority` 順に以下に表示されます。
options	text	リスト項目またはチェックボックスの値を定義する JSON 文字列。リストの場合: `value` プロパティと `text` プロパティを持つオブジェクトの配列。例: `[{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]` チェックボックスの場合: `checked` プロパティと `unchecked` プロパティを持つオブジェクト。例: `{"checked": true, "unchecked": false}` プロパティの動作: - 必須 `type` が "List" または "Checkbox" に設定されている場合

Documentation

User macroオブジェクト

Global macro

Host macro

マクロ設定