Jump to

• Request
• Response
• Examples

Fetch notification template

get

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

Fetches a particular notification template with the specified id.

Request

Path Parameters

• id: number
  Notification template id.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation.

Body ()

Root Schema : FetchNotificationTemplate

Type: object

Show Source

• description(optional): string
  Description of notification template.
• eventname(optional): string
  Event Name of notification template.
• localTemplateCollection(optional): array localTemplateCollection
• templatename(optional): string
  Template name of notification template.

{
    "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."
        }
    }
}

Nested Schema : localTemplateCollection

Type: array

Show Source

• Array of: object 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."
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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."
                }
            }
        }
    }
}

Nested Schema : locale

Type: object

Show Source

• contenttype(optional): string
  Content type of locale template.
• encoding(optional): string
  Encoding of locale template.
• longmessage(optional): string
  Long message of locale template.
• shortmessage(optional): string
  Short message of locale template.
• subject(optional): string
  Subject of locale template.

{
    "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 Response

Invalid input.

Back to Top

Examples

The following example shows how to retrieve a paginated list of all execution history within a specified time range by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

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

Example of Response Body

The following example shows the JSON response for a request to retrieve a paginated list of all execution history within a specified time range:

{
   "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"
}

Back to Top