ジャンプ先

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

通知テンプレートの変更

PUT

/iam/governance/selfservice/api/v1/notification/template/{id}

既存の通知テンプレートを変更します。

リクエスト

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

• application/json

パス・パラメータ

• id: number
  通知テンプレートID。

問合せパラメータ

• status(optional): string
  特定のIDを持つ通知テンプレートのステータスを変更します。

  指定可能な値: [ "Enabled", "Disabled" ]

本文()

既存の通知テンプレートを変更するためのテンプレート詳細。

ルート・スキーマ: ModifyNotificationTemplateBody

型: object

ソースの表示

• description(optional): string
  通知テンプレートの説明。
• eventname(optional): string
  通知テンプレートのイベント名。
• localTemplateCollection(optional): array localTemplateCollection

{
    "type":"object",
    "properties":{
        "localTemplateCollection":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "locale":{
                        "$ref":"#/definitions/LocaleTemplateBody"
                    }
                }
            }
        },
        "eventname":{
            "type":"string",
            "description":"Event Name of notification template."
        },
        "description":{
            "type":"string",
            "description":"Description of notification template."
        }
    }
}

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

型: array

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "locale":{
                "$ref":"#/definitions/LocaleTemplateBody"
            }
        }
    }
}

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

型: object

ソースの表示

• locale(optional): object LocaleTemplateBody

{
    "type":"object",
    "properties":{
        "locale":{
            "$ref":"#/definitions/LocaleTemplateBody"
        }
    }
}

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

型: object

ソースの表示

• contenttype(optional): string
  ロケール・テンプレートのコンテンツ・タイプ。
• encoding(optional): string
  ロケール・テンプレートのエンコーディング。
• longmessage(optional): string
  ロケール・テンプレートの長いメッセージ。
• shortmessage(optional): string
  ロケール・テンプレートの短いメッセージ。
• subject(optional): string
  ロケール・テンプレートの件名。

{
    "type":"object",
    "properties":{
        "subject":{
            "type":"string",
            "description":"Subject of locale template."
        },
        "longmessage":{
            "type":"string",
            "description":"Long message of locale template."
        },
        "shortmessage":{
            "type":"string",
            "description":"Short message of locale template."
        },
        "contenttype":{
            "type":"string",
            "description":"Content type of locale template."
        },
        "encoding":{
            "type":"string",
            "description":"Encoding of locale template."
        }
    }
}

先頭に戻る

レスポンス

204レスポンス

操作に成功しました。

本文()

ルート・スキーマ: ReturnedStatus

型: object

ソースの表示

• status(optional): number
  通知テンプレートのステータス。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"number",
            "description":"Status of notification template."
        }
    }
}

400レスポンス

入力が無効です。

先頭に戻る

例

この例では、すべてのエンティティの物理タイプと名前のリストを取得します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl -i -X PUT -u username:password \
--header 'Content-Type: application/json' \
--header 'X-Requested-By: <anyvalue>' \
--data-raw '{"localTemplateCollection":{"en_US":{"subject":"demo1","shortmessage":"demo1","longmessage":"demo1","contenttype":"text/plain","encoding":"UTF-8"}},"eventname":"EndDateNotificationEvent","templatename":"DemoTemplate","description":"demo1"}' \
'http://pseudo.com/iam/governance/selfservice/api/v1/notification/template/41'

GETレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
   "status":61662
}

先頭に戻る