機械翻訳について

移動先

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

プロジェクトの通知テンプレートの作成

post

/api/v2/projects/{id}/notification_templates_started/

次の通知テンプレート・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このプロジェクトに関連付けられた新しい通知テンプレートを作成します。

• name: この通知テンプレートの名前。(文字列、必須)
• description: この通知テンプレートのオプションの説明。(文字列、デフォルト="")
• organization: (id、必須)
• notification_type: (選択、必須)
  • email: 電子メール
  • grafana: Grafana
  • irc: IRC
  • mattermost: Mattermost
  • pagerduty: Pagerduty
  • rocketchat: Rocket.Chat
  • slack: Slack
  • twilio: Twilio
  • webhook: Webフック
• notification_configuration: (json、デフォルト={})
• messages: 通知テンプレートのオプションのカスタム・メッセージ。(json、デフォルト={'started': None, 'success': None, 'error': None, 'workflow_approval': None})

プロジェクトの通知テンプレートの追加:

このプロジェクトに既存の通知テンプレートを関連付けるには、idフィールドのみを指定してこのリソースに対してPOSTリクエストを行います。

このプロジェクトからの通知テンプレートの除去:

idおよびdisassociateフィールドを指定してこのリソースに対してPOSTリクエストを行うと、通知テンプレートは削除されずに、このプロジェクトから通知テンプレートが除去されます。

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

本文()

ルート・スキーマ : NotificationTemplate

型: object

ソースを表示

• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• id: integer
  タイトル: ID

  読取り専用: true
• messages: object Messages
  タイトル: Messages

  通知テンプレートのオプションのカスタム・メッセージ。
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• notification_configuration: object Notification configuration
  タイトル: Notification configuration
• notification_type(required): string
  タイトル: Notification type

  指定できる値: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
• organization(required): integer
  タイトル: Organization
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

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

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

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "messages":{
            "default":{
            },
            "description":"Optional custom messages for notification template.",
            "title":"Messages",
            "type":"object",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "notification_configuration":{
            "title":"Notification configuration",
            "type":"object"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "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":[
        "name",
        "organization",
        "notification_type"
    ],
    "type":"object"
}

ネストされたスキーマ : メッセージ

型: object

タイトル: Messages

通知テンプレートのオプションのカスタム・メッセージ。

デフォルト値: { }

ネストされたスキーマ : 通知構成

型: object

タイトル: Notification configuration

先頭に戻る

レスポンス

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

• application/json

201レスポンス

本文()

ルート・スキーマ : NotificationTemplate

型: object

ソースを表示

• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• id: integer
  タイトル: ID

  読取り専用: true
• messages: object Messages
  タイトル: Messages

  通知テンプレートのオプションのカスタム・メッセージ。
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• notification_configuration: object Notification configuration
  タイトル: Notification configuration
• notification_type(required): string
  タイトル: Notification type

  指定できる値: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
• organization(required): integer
  タイトル: Organization
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

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

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

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "messages":{
            "default":{
            },
            "description":"Optional custom messages for notification template.",
            "title":"Messages",
            "type":"object",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "notification_configuration":{
            "title":"Notification configuration",
            "type":"object"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "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":[
        "name",
        "organization",
        "notification_type"
    ],
    "type":"object"
}

ネストされたスキーマ : メッセージ

型: object

タイトル: Messages

通知テンプレートのオプションのカスタム・メッセージ。

デフォルト値: { }

ネストされたスキーマ : 通知構成

型: object

タイトル: Notification configuration

先頭に戻る