ジョブ・テンプレートの通知テンプレートのリスト
get
/api/v2/job_templates/{id}/notification_templates_started/
このリソースに対してGETリクエストを行って、選択したジョブ・テンプレートに関連付けられた通知テンプレートのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、対象となる問合せで見つかった通知テンプレートの合計数を示します。 next
フィールドとprevious
フィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 results
リストには、0個以上の通知テンプレート・レコードが含まれます。
結果
それぞれの通知テンプレートのデータ構造には次のフィールドが含まれます。
id
: この通知テンプレートのデータベースID。(整数)type
: この通知テンプレートのデータ型。(選択)url
: この通知テンプレートのURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: この通知テンプレートが作成されたときのタイムスタンプ。(日時)modified
: この通知テンプレートが最後に変更されたときのタイムスタンプ。(日時)name
: この通知テンプレートの名前。(文字列)description
: この通知テンプレートのオプションの説明。(文字列)organization
: (id)notification_type
: (選択)email
: 電子メールgrafana
: Grafanairc
: IRCmattermost
: Mattermostpagerduty
: Pagerdutyrocketchat
: Rocket.Chatslack
: Slacktwilio
: Twiliowebhook
: Webフック
notification_configuration
: (json)messages
: 通知テンプレートのオプションのカスタム・メッセージ。(json)
ソート
通知テンプレートが特定の順序で返されるように指定するには、GETリクエストでorder_by
問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-
を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,
で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size
問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page
問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるprevious
リンクおよびnext
リンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search
問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"count":1,
"next":null,
"previous":null,
"results":[
{
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"id":1,
"messages":{
"error":null,
"started":null,
"success":null,
"workflow_approval":null
},
"modified":"2018-02-01T08:00:00.000000Z",
"name":"test-notification_template",
"notification_configuration":{
"headers":{
"Test":"Header"
},
"password":"",
"url":"http://localhost",
"username":""
},
"notification_type":"webhook",
"organization":1,
"related":{
"copy":"/api/v2/notification_templates/1/copy/",
"notifications":"/api/v2/notification_templates/1/notifications/",
"organization":"/api/v2/organizations/1/",
"test":"/api/v2/notification_templates/1/test/"
},
"summary_fields":{
"organization":{
"description":"test-org-desc",
"id":1,
"name":"test-org"
},
"recent_notifications":[
],
"user_capabilities":{
"copy":true,
"delete":true,
"edit":true
}
},
"type":"notification_template",
"url":"/api/v2/notification_templates/1/"
}
]
}