機械翻訳について

移動先

• リクエスト
• レスポンス

アドホック・コマンドの通知のリスト

get

/api/v2/ad_hoc_commands/{id}/notifications/

このリソースに対して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: この通知が最後に変更されたときのタイムスタンプ。(日時)
• notification_template: (id)
• error: (文字列)
• status: (選択)
  • pending: 保留中
  • successful: 成功
  • failed: 失敗
• notifications_sent: (整数)
• notification_type: (選択)
  • email: 電子メール
  • grafana: Grafana
  • irc: IRC
  • mattermost: Mattermost
  • pagerduty: Pagerduty
  • rocketchat: Rocket.Chat
  • slack: Slack
  • twilio: Twilio
  • webhook: Webフック
• recipients: (文字列)
• subject: (文字列)
• body: 通知本文(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

パス・パラメータ

• id(required): string

問合せパラメータ

• page: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Notification"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object Notification

{
    "items":{
        "$ref":"#/definitions/Notification"
    },
    "type":"array"
}

ネストされたスキーマ: Notification

型: object

ソースを表示

• body: string
  タイトル: Body

  読取り専用: true

  通知本文
• created: string
  タイトル: Created

  読取り専用: true
• error: string
  タイトル: Error

  読取り専用: true

  最小長: 1
• id: integer
  タイトル: ID

  読取り専用: true
• modified: string
  タイトル: Modified

  読取り専用: true
• notification_template: integer
  タイトル: Notification template

  読取り専用: true
• notification_type(required): string
  タイトル: Notification type

  指定できる値: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
• notifications_sent: integer
  タイトル: Notifications sent

  読取り専用: true
• recipients: string
  タイトル: Recipients

  読取り専用: true

  最小長: 1
• related: string
  タイトル: Related

  読取り専用: true
• status: string
  タイトル: Status

  読取り専用: true

  指定できる値: [ "pending", "successful", "failed" ]
• subject: string
  タイトル: Subject

  読取り専用: true

  最小長: 1
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "body":{
            "description":"Notification body",
            "readOnly":true,
            "title":"Body",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "error":{
            "minLength":"1",
            "readOnly":true,
            "title":"Error",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "notification_template":{
            "readOnly":true,
            "title":"Notification template",
            "type":"integer"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "notifications_sent":{
            "readOnly":true,
            "title":"Notifications sent",
            "type":"integer"
        },
        "recipients":{
            "minLength":"1",
            "readOnly":true,
            "title":"Recipients",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "status":{
            "enum":[
                "pending",
                "successful",
                "failed"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "subject":{
            "minLength":"1",
            "readOnly":true,
            "title":"Subject",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "notification_type"
    ],
    "type":"object"
}

先頭に戻る