ジャンプ先

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

通知テンプレートのフェッチ

GET

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

指定されたIDを持つ特定の通知テンプレートをフェッチします。

リクエスト

パス・パラメータ

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作に成功しました。

本文()

ルート・スキーマ: FetchNotificationTemplate

型: object

ソースの表示

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

{
    "type":"object",
    "properties":{
        "localTemplateCollection":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "locale":{
                        "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."
                            }
                        }
                    }
                }
            }
        },
        "eventname":{
            "type":"string",
            "description":"Event Name of notification template."
        },
        "templatename":{
            "type":"string",
            "description":"Template name of notification template."
        },
        "description":{
            "type":"string",
            "description":"Description of notification template."
        }
    }
}

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

型: array

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "locale":{
                "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."
                    }
                }
            }
        }
    }
}

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

型: object

ソースの表示

• locale(optional): object locale

{
    "type":"object",
    "properties":{
        "locale":{
            "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."
                }
            }
        }
    }
}

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

型: 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."
        }
    }
}

400レスポンス

入力が無効です。

先頭に戻る

例

次の例は、cURLを使用してGETリクエストを発行することで、指定した時間範囲内のすべての実行履歴のページ区切りリストを取得する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl -i -X GET -u username:password \
--header 'Content-Type: application/json' \
'http://pseudo.com:14000/iam/governance/selfservice/api/v1/notification/template/41'

レスポンス本文の例

次の例は、指定した時間範囲内のすべての実行履歴のページ区切りリストを取得するリクエストに対するJSONレスポンスを示しています:

{
   "localTemplateCollection":{
      "en_US":{
         "subject":"demo",
         "shortmessage":"demo",
         "longmessage":"demo",
         "contenttype":"text/plain",
         "encoding":"UTF-8"
      }
   },
   "eventname":"EndDateNotificationEvent",
   "templatename":"DemoTemplate",
   "description":"DemoDescription",
   "createuser":"1",
   "status":"Enabled"
}

先頭に戻る