Update Alert Content
Update an alert content.
Request Parameters (URI)
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get orgId>> |
isPatchUpdate |
Query |
Mandatory |
Boolean |
- true (default) = Only the fields specified in the parameters are updated. The values of those fields not specified will be retained.
- false = The fields specified in the parameters are updated. Those fields not specified will have their existing values (if any) deleted.
|
Request Parameters (Body)
Name |
Mandatory/Optional |
Data Type |
Description |
alertContent |
Mandatory |
GenerateContent Struct |
The details of the alert content. For more information, see GenerateContent Struct. |
GenerateContent Struct
Name |
Mandatory/Optional |
Data Type |
Description |
contentId |
Mandatory |
String |
The alert content ID. |
contentDesc |
Mandatory |
String |
The alert content description. |
modelId |
Mandatory |
String |
The model ID. How to get modelID>> |
alertTypeId |
Mandatory |
String |
The alert type ID. |
tags |
Optional |
Map |
User-defined tags. (The Key and Value are of String type.) For details, see How to use tags. |
Samples
Request Sample
url: https://{apigw-address}/event-service/v2.1/alert-contents?action=update&orgId=yourOrgId&isPatchUpdate=false
method: POST
requestBody:
{
"alertContent": {
"contentId": "planetTemperature",
"contentDesc": {
"defaultValue": "Grid is connected from converter",
"i18nValue": {
"en_US": "Grid is connected from converter",
"zh_CN": "风机已并网"
}
},
"modelId": "WindDev-E0",
"alertTypeId": "9001",
"tags": {
"year": "2000",
"author": "cshan"
}
},
"action": "update"
}
Return Sample
{
"code": 0,
"msg": "OK",
"requestId": "4873095e-621d-4cfd-bc2c-edb520f574ea",
"data": null
}
SDK Samples
You can access the SDK samples for alert engine service on GitHub: