REST API for Notification in OIG

Modify notification template

put

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

Modifies an existing notification template.

Request

Supported Media Types

application/json

Path Parameters

id: number

Notification template id.

Query Parameters

status(optional): string

Modifies the status of notification template with the specific id.

Allowed Values: [ "Enabled", "Disabled" ]

Template details to modify an already existing notification template.

Root Schema : ModifyNotificationTemplateBody

Type: object

Show Source

description(optional): string

Description of notification template.
eventname(optional): string

Event Name of notification template.
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."
        }
    }
}

Nested Schema : localTemplateCollection

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

locale(optional): object LocaleTemplateBody

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

Nested Schema : LocaleTemplateBody

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

Response

204 Response

successful operation.

Root Schema : ReturnedStatus

Type: object

Show Source

status(optional): number

Status of notification template.

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

400 Response

Invalid input.

Examples

This example retrieves list of all entity physical type and names. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

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'

Example of GET Response Body

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

{
   "status":61662
}