Request URL
https://<BMC Helix Portal URL>/ans/api/v1/profiles/{label}
Content-Type: application/json
Authorization: Bearer <JWT_token>
Request body
{
"severity":"INFO",
"recipients":{
"additionalProp":[
"string"
]
},
"description":"string",
"enabled":true,
"category":"string",
"display_name":"string",
"channels":{
"inapp":{
"header":"string",
"message":"string",
"expiry":"string",
"banner":false
}
}
}
Example request body
{
"severity":"INFO",
"category":"ANS",
"display_name":"Display global recipients",
"description":"description",
"recipients":{
"group_ids":[
"group1"
]
},
"channels":{
"inapp":{
"header":"New User got added",
"message":"New user \"$params.user_name\" added & associated with group \"$params.group_name\"",
"expiry":"3"
}
}
}
Parameters
Name | Located in | Description | Mandatory | Schema |
---|
label | path | Label of the notification profile you want to update | yes | string |
severity | body | Updated severity for the notification profile Valid values: | no | string |
category | body | Updated category of the notification profile | no | string |
display_name | body | Updated display name of the notification profile | no | string |
description | body | Updated description the notification profile | no | string |
recipients | body | List of recipients to send notification to which notification should be sent Valid values: - "groups":[group names]
- "group_ids":[group ids]
- "users":[user/principal names]
- "user_ids":[user ids]
- "keywords" : ["ALL_USERS]
| no | string |
Successful response
{
"label": "string"
}
Unsuccessful response
Scenario: When a label contains spaces or special characters such as $ and @
{
"timestamp": "2022-01-19T06:58:38.949405100Z",
"transactionId": "d032f6eb-3cbd-49fc-8f6b-85bb13a5efd5",
"code": 400,
"message": "createNotificationProfile.profileLabel: Label can only contain these characters [A-Za-z0-9_-], createNotificationProfile.profileLabel: label is mandatory."
}
Comments
Log in or register to comment.