3.64. report-template
レポートテンプレートを操作します。
使用方法
hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...
# hammer report-template [OPTIONS] SUBCOMMAND [ARG] ...
オプション
-
-h
、--help
– ヘルプを表示します。
3.64.1. report-template clone リンクのコピーリンクがクリップボードにコピーされました!
テンプレートのクローンを作成します。
使用方法
hammer report-template clone [OPTIONS]
# hammer report-template clone [OPTIONS]
オプション
-
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– テンプレート名 -
--new-name VALUE
-
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
-h
、--help
– ヘルプを表示します。
3.64.2. report-template create リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートを作成します。
使用方法
hammer report-template create [OPTIONS]
# hammer report-template create [OPTIONS]
オプション
-
--audit-comment VALUE
-
--default BOOLEAN
– テンプレートが新しい組織やロケーションに自動的に追加されるかどうかを指定します。 -
--description VALUE
-
--file FILE
– レポートテンプレートの内容を含むファイルへのパス -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-ids LIST
– 指定された ID でロケーションを置換します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-titles LIST
-
--locations LIST
-
--locked BOOLEAN
– テンプレートが編集用にロックされているかどうかを指定します。 -
--name VALUE
-
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-ids LIST
– 指定された ID で組織を置き換えます。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-titles LIST
-
--organizations LIST
-
--snippet BOOLEAN
-
-h
、--help
– ヘルプを表示します。 -
-i
,--interactive
– $EDITOR で空のテンプレートを開きます。結果をアップロードします。
3.64.3. report-template delete リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートを削除します。
使用方法
hammer report-template <delete|destroy> [OPTIONS]
# hammer report-template <delete|destroy> [OPTIONS]
オプション
-
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
-h
、--help
– ヘルプを表示します。
3.64.4. report-template dump リンクのコピーリンクがクリップボードにコピーされました!
レポートコンテンツを表示します。
使用方法
hammer report-template dump [OPTIONS]
# hammer report-template dump [OPTIONS]
オプション
-
--fields LIST
– 指定されたフィールドまたは定義済みフィールドセットのみを表示します。以下を参照してください。 -
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
-h
、--help
– ヘルプを表示します。
フィールド |
3.64.5. report-template export リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートを ERB にエクスポートします。
使用方法
hammer report-template export [OPTIONS]
# hammer report-template export [OPTIONS]
オプション
-
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--path VALUE
– ダウンロードしたコンテンツが保存されるディレクトリーへのパス -
-h
、--help
– ヘルプを表示します。
3.64.6. report-template generate リンクのコピーリンクがクリップボードにコピーされました!
レポートを生成します。
使用方法
hammer report-template generate [OPTIONS]
# hammer report-template generate [OPTIONS]
オプション
-
--gzip BOOLEAN
– gzip を使用してレポートを圧縮します。 -
--id VALUE
-
--inputs KEY_VALUE_LIST
– 入力を指定します。 -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--path VALUE
– ダウンロードしたコンテンツが保存されるディレクトリーへのパス -
--report-format ENUM
– レポート形式。デフォルトはcsv
です。使用できる値は、csv
、json
、yaml
、html
です。 -
-h
、--help
– ヘルプを表示します。
3.64.7. report-template import リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートをインポートします。
使用方法
hammer report-template import [OPTIONS]
# hammer report-template import [OPTIONS]
オプション
-
--associate ENUM
– テンプレートがメタデータに基づいてオブジェクトを関連付けるタイミングを決定します。new は新しいテンプレートが作成される場合のみを示し、always は新しいテンプレートと更新される既存のテンプレートの両方を示します。never はメタデータを無視します。使用できる値は、new
、always
、never
です。 -
--default BOOLEAN
– テンプレートをデフォルトにして、新しく作成された組織とロケーションを関連付けます (デフォルトでは false)。 -
--file FILE
– メタデータを含むレポートテンプレートコンテンツを含むファイルへのパス -
--force BOOLEAN
– ロックされたテンプレートを更新する場合に使用します。 -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-ids LIST
– 指定された ID でロケーションを置換します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-titles LIST
-
--locations LIST
-
--lock BOOLEAN
– インポートされたテンプレートをロックします (デフォルトでは false)。 -
--name VALUE
– テンプレート名 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-ids LIST
– 指定された ID で組織を置き換えます。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-titles LIST
-
--organizations LIST
-
-h
、--help
– ヘルプを表示します。
3.64.8. report-template info リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートを表示します。
使用方法
hammer report-template <info|show> [OPTIONS]
# hammer report-template <info|show> [OPTIONS]
オプション
-
--fields LIST
– 指定されたフィールドまたは定義済みフィールドセットのみを表示します。以下を参照してください。 -
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
-h
、--help
– ヘルプを表示します。
フィールド | すべて | デフォルト | シン |
---|---|---|---|
Id | x | x | x |
Name | x | x | x |
Description | x | x | |
Locked | x | x | |
Default | x | x | |
Created at | x | x | |
Updated at | x | x | |
Locations/ | x | x | |
Organizations/ | x | x | |
Template inputs/id | x | x | |
Template inputs/name | x | x | |
Template inputs/description | x | x | |
Template inputs/required | x | x | |
Template inputs/options | x | x |
3.64.9. report-template list リンクのコピーリンクがクリップボードにコピーされました!
すべてのレポートテンプレートをリスト表示します。
使用方法
hammer report-template <list|index> [OPTIONS]
# hammer report-template <list|index> [OPTIONS]
オプション
-
--fields LIST
– 指定されたフィールドまたは定義済みフィールドセットのみを表示します。以下を参照してください。 -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– 場所によるスコープ -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--order VALUE
– 検索可能なフィールドで並べ替え、順序付けします。たとえば<field> DESC
です。 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– 組織によるスコープ -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--page NUMBER
– (1 から始まる) ページ番号 -
--per-page VALUE
– 1 ページあたりの、返される結果の数。all
を指定すると、すべての結果が返されます。 -
--search VALUE
– 結果をフィルタリングします。 -
-h
、--help
– ヘルプを表示します。
フィールド | すべて | デフォルト | シン |
---|---|---|---|
Id | x | x | x |
Name | x | x | x |
検索/順序フィールド
-
default
– 値は true、false です。 -
id
– 整数 -
location
– 文字列 -
location_id
– 整数 -
locked
– 値は true、false です。 -
name
– 文字列 -
organization
– 文字列 -
organization_id
– 整数 -
snippet
– 値は true、false です。 -
template
– テキスト
3.64.10. report-template report-data リンクのコピーリンクがクリップボードにコピーされました!
生成したレポートをダウンロードします。
使用方法
hammer report-template report-data [OPTIONS]
# hammer report-template report-data [OPTIONS]
オプション
-
--id VALUE
-
--job-id VALUE
– schedule コマンドでジョブの生成に割り当てられた ID -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--path VALUE
– ダウンロードしたコンテンツが保存されるディレクトリーへのパス -
-h
、--help
– ヘルプを表示します。
3.64.11. report-template schedule リンクのコピーリンクがクリップボードにコピーされました!
レポートの生成をスケジュールします。
使用方法
hammer report-template schedule [OPTIONS]
# hammer report-template schedule [OPTIONS]
オプション
-
--generate-at VALUE
– レポートを生成する UTC 時間 -
--gzip BOOLEAN
– gzip を使用してレポートを圧縮します。 -
--id VALUE
-
--inputs KEY_VALUE_LIST
– 入力を指定します。 -
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--mail-to VALUE
– これが設定されていると、スケジュールされたレポートがメールで配信されます。複数のメールアドレスを区切るには,
を使用します。 -
--name VALUE
– 検索する名前 -
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--path VALUE
– ダウンロードしたコンテンツが保存されるディレクトリーへのパス。wait が指定されている場合にのみ使用できます。 -
--report-format ENUM
– レポート形式。デフォルトはcsv
です。使用できる値は、csv
、json
、yaml
、html
です。 -
--wait
– コマンドをアクティブにして、結果を待ってすぐにダウンロードします。 -
-h
、--help
– ヘルプを表示します。
3.64.12. report-template update リンクのコピーリンクがクリップボードにコピーされました!
レポートテンプレートを更新します。
使用方法
hammer report-template update [OPTIONS]
# hammer report-template update [OPTIONS]
オプション
-
--audit-comment VALUE
-
--default BOOLEAN
– テンプレートが新しい組織やロケーションに自動的に追加されるかどうかを指定します。 -
--description VALUE
-
--file FILE
– レポートテンプレートの内容を含むファイルへのパス -
--id VALUE
-
--location VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-id NUMBER
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-ids LIST
– 指定された ID でロケーションを置換します。 -
--location-title VALUE
– リクエストの現在のロケーションコンテキストを設定します。 -
--location-titles LIST
-
--locations LIST
-
--locked BOOLEAN
– テンプレートが編集用にロックされているかどうかを指定します。 -
--name VALUE
-
--new-name VALUE
-
--organization VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-id NUMBER
– リクエストの現在の組織コンテキストを設定します。 -
--organization-ids LIST
– 指定された ID で組織を置き換えます。 -
--organization-title VALUE
– リクエストの現在の組織コンテキストを設定します。 -
--organization-titles LIST
-
--organizations LIST
-
--snippet BOOLEAN
-
-h
、--help
– ヘルプを表示します。 -
-i
、--interactive
- 既存のテンプレートをダンプし、$EDITOR で開きます。結果を更新します。