REST API for Notification in OIG

Create new notification template

post

/iam/governance/selfservice/api/v1/notification/template

Creates a new notification template in OIG.

Request

Supported Media Types

application/json

Template details for new notification template to be created.

Root Schema : CreateNotificationTemplateBody

Type: object

Show Source

description(optional): string

Description of notification template.
eventname(optional): string

Event Name of notification template.
templatename(optional): string

Template name of notification template.

{
    "type":"object",
    "properties":{
        "templatename":{
            "type":"string",
            "description":"Template name of notification template."
        },
        "eventname":{
            "type":"string",
            "description":"Event Name of notification template."
        },
        "description":{
            "type":"string",
            "description":"Description of notification template."
        }
    }
}

Response

201 Response

successful operation.

Root Schema : ReturnedTemplateId

Type: object

Show Source

templateid(optional): number

Template id of notification template.

{
    "type":"object",
    "properties":{
        "templateid":{
            "type":"number",
            "description":"Template id of notification template."
        }
    }
}

400 Response

Invalid input.

Examples

This example retrieves account information for a given account. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X POST -u username:password \
--header 'Content-Type: application/json' \
--header 'X-Requested-By: <anyvalue>' \
--data-raw '{"eventname":"EndDateNotificationEvent","templatename":"DemoTemplate","description":"DemoDescription"}' \
'http://psuedo.com:14000/iam/governance/selfservice/api/v1/notification/template'

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
   "templateid":41
}