Alert type group API documentation version v1
https://Application_URL/services/api/v1
About Alert type group
It helps define alert type group. Also associations between alert type group and alert types.
Purpose
This API allows you to read alert type group, associate alert type to alert type groups and delete alert type groups.
/alerttypegroups
This endpoint allows you to read alert type groups.
This endpoint allows you to create alert type groups.
This endpoint allows you edit alert type groups.
get /alerttypegroups
This endpoint allows you to read alert type groups.
Query Parameters
- $filter: (string)
Retrieves alert type groups based on the value provided. This parameter follows ODATA URL covention. For eg $filter=alertTypeGroupID eq 'Demo'
HTTP status code 200
No Content
Body
Media type: application/json
Type: any
Example:
{
"alertTypeGroupID": "DemoAlertTypeGroup",
"description": {
"languageISoCode": "en",
"shortDescription": "demo group",
"longDescription": "demo alert type group"
},
"alertTypeID": [
"136C1C6BF10444628A14411893F1D0EC"
],
"systemAdministrativeData": {
"systemAdministrativeDataCreatedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataCreationDateTime": 1551348078009,
"systemAdministrativeDataLastChangedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataLastChangeDateTime": 1551348141663
}
}Secured by
post /alerttypegroups
This endpoint allows you to create alert type groups.
Body
Media type: application/json
Example:
{
"alertTypeGroupID": "DemoAlertTypeGroup",
"description": {
"shortDescription": "demo group",
"longDescription": "demo alert type group"
}
}HTTP status code 200
No Content
Body
Media type: application/json
Type: any
Example:
{
"alertTypeGroupID": "DemoAlertTypeGroup",
"description": {
"languageISoCode": "en",
"shortDescription": "demo group",
"longDescription": "demo alert type group"
},
"alertTypeID": [],
"systemAdministrativeData": {
"systemAdministrativeDataCreatedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataCreationDateTime": 1551348078009,
"systemAdministrativeDataLastChangedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataLastChangeDateTime": 1551348141663
}
}HTTP status code 400
Error message will be thrown alert type groups already exists.
Body
Media type: application/json
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Alert type group already exists.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by
put /alerttypegroups
This endpoint allows you edit alert type groups.
Body
Media type: application/json
Example:
{
"alertTypeGroupID": "DemoAlertTypeGroup",
"description": {
"shortDescription": "demo group",
"longDescription": "demo alert type group"
},
"alertTypeID": [
{
"id": "136C1C6BF10444628A14411893F1D0EC1"
}
]
}HTTP status code 200
No Content
Body
Media type: application/json
Type: any
Example:
{
"alertTypeGroupID": "DemoAlertTypeGroup",
"description": {
"languageISoCode": "en",
"shortDescription": "demo group",
"longDescription": "demo alert type group"
},
"alertTypeID": [
"136C1C6BF10444628A14411893F1D0EC"
],
"systemAdministrativeData": {
"systemAdministrativeDataCreatedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataCreationDateTime": 1551348078009,
"systemAdministrativeDataLastChangedByUserID": "F9748B5D138D4BCCB093426C86336B65",
"systemAdministrativeDataLastChangeDateTime": 1551348141663
}
}HTTP status code 400
Error message will be thrown alert type groups doesn't exist.
Body
Media type: application/json
Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Invalid alert types cannot be assigned to alert type group.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by
/alerttypegroups/{alerttypegroupId}
This endpoint allows you to delete an alert type group.
delete /alerttypegroups/{alerttypegroupId}
This endpoint allows you to delete an alert type group.
URI Parameters
- alerttypegroupId: required(string)
HTTP status code 204
No Content
HTTP status code 400
Error message will be thrown for invalid alert type group id.
Body
Media type: application/json
Example:
{
"statusCode": 400,
"errorMessages": [
{
"errorMessage": "Alert type group id does not exist",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}