APM Alarm Management is a RESTful web service for alerts management services. This document gives an overview of the APM Alarm Management API services.
HTTP verbs
APM Gateway tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, including partial updates |
|
Used to delete an existing resource |
HTTP status codes
APM Gateway tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The request completed successfully |
|
A new resource has been created successfully. The resource’s URI is available from the response’s
|
|
An update to an existing resource has been applied successfully |
|
The request was malformed. The response body will include an error providing further information |
|
The requested resource did not exist |
V1 APIs
Creating a SmartSignal Alarm
A POST
request is used to create alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}'
Example HTTP request
POST /alertmgmt/v1/alarms HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 1410
Host: www.predixapis.com
{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*This should match the name of the Alarm Profile that already exists in APM |
|
|
*Asset UUID, which is already ingested in APM Asset |
|
|
Event Generated Date, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC is time at which the event was generated. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
Time when alert was received by APM system, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten. |
|
|
Key value pairs of Sensor:Value information that triggered the alarm. Example:{"BRG_1_VIB_2_1X_AMP":"53.95484042","BRG_1_VIB_1_OVERALL":"62.4367112"} |
|
|
Incident object contains more details like the number of time the alarm was triggered, datetime of first and last occurrence. First occurrence and last occurrence should be in YYYY-MM-DDTHH:MM:SS.SSSZ UTC format. Example:{"incidentEventCount":"125","firstOccurance":"2015-08-11T19:07:00.000Z","lastOccurance":"2015-08-19T15:47:00.000Z"} |
|
|
This contains the tag information that an analyst may be interested of in analyzing the alarm. Example:tagsOfInterest":[{"uuid":"e6d65833-028f-4d0f-b0cc-8334bdcf2d53","isContributing":false,"displayGrouped":true,"displayGroupedName":"DRIVER_LOAD","uom":"KLB/HR"},{"uuid":"8288f357-4ab2-4e99-ab14-c0717b27fe5b","isContributing":false,"displayGrouped":true,"displayGroupedName":"PUMP_SPEED","uom":"rpm"}] |
|
|
Tenant under which this alarm will be created and is accessible |
|
|
id |
|
|
isActive |
|
|
if the alarm is a recurring alarm |
|
|
if the alarm has limited visibility |
|
|
Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored |
|
|
disablePrefetch flag |
|
|
This days calculated between Event Time and Alert Creation time |
|
|
This flag used to identify whether alert is Stale or Not |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 151
{
"uuid" : "9EA0C838F14E4872A0C5D473E7C61CDF",
"links" : [ {
"rel" : "self",
"href" : "/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF"
} ]
}
Getting an Alarm by UUID
A GET
request is used to get alarm details.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 4947
{
"severity" : 3,
"isTrip" : false,
"timeseriesCached" : false,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"type" : "Generic",
"source" : "SmartSignal",
"templated" : true,
"templateName" : "TEST_SS_PROFILE",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"uuid" : "9EA0C838F14E4872A0C5D473E7C61CDF",
"isActive" : true,
"createdOn" : 1702359437041,
"updatedOn" : 1702359437138,
"sourceKey" : "73e0c2b7-9352-4cc6-9304-ade50bd4a983",
"id" : 51,
"alarmState" : {
"id" : 1,
"uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
"isActive" : true,
"createdOn" : 1702357679363,
"locale" : "en-US",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"name" : "Ready",
"description" : "Ready"
},
"alarmAsset" : {
"id" : 4,
"uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"isActive" : true,
"createdOn" : 1702358408100,
"updatedOn" : 1702358408100,
"assetUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"assetNameLower" : "test1234",
"siteName" : "CONSTELLATION",
"siteNameLower" : "constellation",
"assetCustomerName" : "SS Test Enterprise",
"assetCustomerNameLower" : "ss test enterprise",
"assetSourceKey" : "test1234",
"assetSourceKeyLower" : "test1234",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"assetTimeZone" : "",
"parentName" : "CONSTELLATION",
"parentNameLower" : "constellation",
"criticalityDescription" : "",
"criticalityValue" : 0,
"criticalityColor" : ""
},
"processorClassName" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"latchCount" : 1,
"lastOccurrence" : 1439999220000,
"previousSeverity" : 3,
"firstOccurrence" : 1439320020000,
"lastProcessedTime" : 1439320020000,
"lastObservationTime" : 1439320020000,
"analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"trip" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
},
"associatedMonitoredEntity" : {
"uuid" : "/assets/468fdf6c-2d44-35b8-957d-19b104b70599",
"equipmentId" : "test1234",
"name" : "test1234",
"enterprise" : {
"name" : "SS Test Enterprise"
},
"site" : {
"name" : "CONSTELLATION",
"address" : { }
},
"contact" : {
"name" : "test1234"
},
"assetType" : {
"uri" : "/assetTypes/d395b287-0730-395b-bc1f-2d9ed0dbf3cf",
"sourcekey" : "test1234",
"name" : "test1234"
},
"reservedAttributes" : {
"make" : null,
"maintenancecriticalityriskscore" : null,
"faultmode" : null
},
"userPermissions" : [ "Manage Alerts", "View Limited Visibility Alerts" ]
},
"alarmProfile" : {
"id" : 49,
"createdOn" : 1469742971359,
"updatedOn" : 1469664000000,
"uuid" : "9CB257D33B674C64804EDCE48C6CF75A",
"isActive" : true,
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"name" : "TEST_SS_PROFILE",
"description" : "Test ss profile -- do not delete.",
"source" : {
"id" : 12,
"name" : "SmartSignal",
"description" : "SmartSignal",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"uuid" : "93E04CA186EE4BA496C1DBB304953067",
"isActive" : true
},
"type" : {
"id" : 8,
"name" : "Generic",
"description" : "Generic",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
"isActive" : true
},
"severity" : 1,
"isConsumable" : true,
"isTrip" : false,
"validateAsset" : true,
"isActiveProfile" : true,
"templateLinks" : [ ]
}
}
Note: API response will contain user owner details only when alarm is claimed. If you are generating alarm though back end process with user owner details then alarm state should be either in InProcess or Processed state. In this case API will return userOwner details.
Patching an Alarm
A PATCH
request is used to patch an alarm.
Request structure
Path | Type | Description |
---|---|---|
|
|
A list of patch operations to perform |
|
|
*Type of patch operation, possible values are: ADD, REPLACE and REMOVE |
|
|
*This is the alarm field to patch. In this case, alarmDisposition.name |
|
|
*The new value of the field |
*Required fields
Example CURL request 1
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF' -i -X PATCH \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]'
Example HTTP request 1
PATCH /alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 84
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]
Example response 1
HTTP/1.1 401 Unauthorized
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 215
{
"path" : "/alertmgmt",
"requestId" : "809493f1-b780-459d-a956-30733aebc665",
"errorId" : "PATCH_UNAUTHORIZED",
"errorMessage" : "Unauthorized access patch call.:",
"timestamp" : "2023-12-12T05:37+0000"
}
Note: The Disposition/State of an alert cannot be updated if the alert is not claimed by the user. The above is an example for invalid patch operation.
Please refer Example HTTP request 2 for claim operation. ("value" field should contain UUID of logged in user)
Example HTTP request 2
PATCH /alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 107
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/userOwnerUuid",
"value" : "88c29d94-a058-4594-9b2c-d8e0e5924d48"
} ]
Example response 2
HTTP/1.1 200 OK
Example HTTP request 3
PATCH /alertmgmt/v1/alarms/9EA0C838F14E4872A0C5D473E7C61CDF HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 95
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmState/name",
"value" : "In Process Maintenance"
} ]
Example response 3
HTTP/1.1 200 OK
Filter for Alarms
A POST
request is used to filter alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/filter' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v1/alarms/filter HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 880
Host: www.predixapis.com
{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
Name of the filter |
|
|
User ID of the filter |
|
|
If this filter is the default filter set, either true or false |
|
|
List of filter(s) |
|
|
Type of filter operation. Possible values are: contains |
|
|
Operand2 can be a filter text or dropdpwn values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" , |
|
|
Operand1 |
|
|
Class that builds the operand |
|
|
Name of the operand |
|
|
Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE |
|
|
Path of the operand |
|
|
Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE |
|
|
Operation Translations |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Aggregation of Alarms
A POST
request is used to aggregate alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v1/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 514
Host: www.predixapis.com
{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request Parameters
Parameter | Description |
---|---|
|
Comma separated List of Alarm Entity attributes are its descendent’s attributes |
|
Comma separated List of Aggregated Alarm Entity numeric attributes |
|
Field selected for orderBy eg: id-count |
|
ASC or DESC |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Getting Tenant Configurations
A GET
request is used get tenant configurations.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/tenantConfig' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v1/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 188
{
"disposition" : [ {
"id" : 1286,
"name" : "Alarm-Disposition-Name",
"uuid" : "uuid",
"isActive" : true,
"isDeleted" : false,
"displayOrder" : 2147483647
} ]
}
Response structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
name of tenant configuration |
|
|
Unique ID of tenant configuration |
|
|
false if tenant configuration is deprecated, true otherwise |
|
|
true if tenant configuration deleted, false otherwise |
|
|
display order for tenant configuration |
Create Tenant Configuration
A POST
request is used to create tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v1/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 178
Host: www.predixapis.com
{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
name of tenant configuration |
|
|
description of disposition |
|
|
Unique ID of disposition |
|
|
Language of disposition |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Update Tenant Configuration
A POST
request is used to update tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"id" : 1286,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v1/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 157
Host: www.predixapis.com
{
"disposition" : [ {
"id" : 1286,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
Description of the disposition |
|
|
uuid of the disposition |
|
|
language of name |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Getting Custom Attributes
A GET
request is used get custom attributes.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/customattribute' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v1/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186
[ {
"id" : 5,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
} ]
Response structure
Path | Type | Description |
---|---|---|
|
|
id of custom attribute |
|
|
variable name of custom attribute |
|
|
display name of custom attribute |
|
|
the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
visibility of custom attribute on front end |
|
|
min value of NUMBER type custom attribute |
|
|
max value of NUMBER type custom attribute |
Create Custom Attribute
A POST
request is used to create custom attribute.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v1/alarms/customattribute' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}'
Example HTTP request
POST /alertmgmt/v1/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 182
Host: www.predixapis.com
{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*Custom Attribute Id |
|
|
*The name that will represent the custom attribute value. Cannot already exist in the tenant. |
|
|
*The display name of the custom attribute, which will be shown on the front-end. |
|
|
*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
*Boolean whether the custom attribute will be displayed on the front-end. |
|
|
*The minimum value the custom attribute can be (only applies to type NUMBER). |
|
|
*The maximum value the custom attribute can be (only applies to type NUMBER). |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 182
{
"id" : 5,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
V3 APIs
Creating a SmartSignal Alarm
A POST
request is used to create alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}'
Example HTTP request
POST /alertmgmt/v3/alarms HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 1410
Host: www.predixapis.com
{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*This should match the name of the Alarm Profile that already exists in APM |
|
|
*Asset UUID, which is already ingested in APM Asset |
|
|
Event Generated Date, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC is time at which the event was generated. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
Time when alert was received by APM system, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten. |
|
|
Key value pairs of Sensor:Value information that triggered the alarm. Example:{"BRG_1_VIB_2_1X_AMP":"53.95484042","BRG_1_VIB_1_OVERALL":"62.4367112"} |
|
|
Incident object contains more details like the number of time the alarm was triggered, datetime of first and last occurrence. First occurrence and last occurrence should be in YYYY-MM-DDTHH:MM:SS.SSSZ UTC format. Example:{"incidentEventCount":"125","firstOccurance":"2015-08-11T19:07:00.000Z","lastOccurance":"2015-08-19T15:47:00.000Z"} |
|
|
This contains the tag information that an analyst may be interested of in analyzing the alarm. Example:tagsOfInterest":[{"uuid":"e6d65833-028f-4d0f-b0cc-8334bdcf2d53","isContributing":false,"displayGrouped":true,"displayGroupedName":"DRIVER_LOAD","uom":"KLB/HR"},{"uuid":"8288f357-4ab2-4e99-ab14-c0717b27fe5b","isContributing":false,"displayGrouped":true,"displayGroupedName":"PUMP_SPEED","uom":"rpm"}] |
|
|
Tenant under which this alarm will be created and is accessible |
|
|
id |
|
|
isActive |
|
|
if the alarm is a recurring alarm |
|
|
if the alarm has limited visibility |
|
|
Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored |
|
|
disablePrefetch flag |
|
|
This days calculated between Event Time and Alert Creation time |
|
|
This flag used to identify whether alert is Stale or Not |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 196
{
"uuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"links" : [ {
"rel" : "self",
"href" : "/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/B9FF7BD3C4354F989D802D0CB598F6E4"
} ]
}
Getting an Alarm by UUID
A GET
request is used to get alarm details.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 4947
{
"severity" : 3,
"isTrip" : false,
"timeseriesCached" : false,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"type" : "Generic",
"source" : "SmartSignal",
"templated" : true,
"templateName" : "TEST_SS_PROFILE",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"uuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isActive" : true,
"createdOn" : 1702359416076,
"updatedOn" : 1702359416309,
"sourceKey" : "ee753e24-b8a4-46f2-89d9-891226d2e933",
"id" : 50,
"alarmState" : {
"id" : 1,
"uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
"isActive" : true,
"createdOn" : 1702357679363,
"locale" : "en-US",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"name" : "Ready",
"description" : "Ready"
},
"alarmAsset" : {
"id" : 4,
"uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"isActive" : true,
"createdOn" : 1702358408100,
"updatedOn" : 1702358408100,
"assetUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"assetNameLower" : "test1234",
"siteName" : "CONSTELLATION",
"siteNameLower" : "constellation",
"assetCustomerName" : "SS Test Enterprise",
"assetCustomerNameLower" : "ss test enterprise",
"assetSourceKey" : "test1234",
"assetSourceKeyLower" : "test1234",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"assetTimeZone" : "",
"parentName" : "CONSTELLATION",
"parentNameLower" : "constellation",
"criticalityDescription" : "",
"criticalityValue" : 0,
"criticalityColor" : ""
},
"processorClassName" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"latchCount" : 1,
"lastOccurrence" : 1439999220000,
"previousSeverity" : 3,
"firstOccurrence" : 1439320020000,
"lastProcessedTime" : 1439320020000,
"lastObservationTime" : 1439320020000,
"analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"trip" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
},
"associatedMonitoredEntity" : {
"uuid" : "/assets/468fdf6c-2d44-35b8-957d-19b104b70599",
"equipmentId" : "test1234",
"name" : "test1234",
"enterprise" : {
"name" : "SS Test Enterprise"
},
"site" : {
"name" : "CONSTELLATION",
"address" : { }
},
"contact" : {
"name" : "test1234"
},
"assetType" : {
"uri" : "/assetTypes/d395b287-0730-395b-bc1f-2d9ed0dbf3cf",
"sourcekey" : "test1234",
"name" : "test1234"
},
"reservedAttributes" : {
"make" : null,
"maintenancecriticalityriskscore" : null,
"faultmode" : null
},
"userPermissions" : [ "Manage Alerts", "View Limited Visibility Alerts" ]
},
"alarmProfile" : {
"id" : 49,
"createdOn" : 1469742971359,
"updatedOn" : 1469664000000,
"uuid" : "9CB257D33B674C64804EDCE48C6CF75A",
"isActive" : true,
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"name" : "TEST_SS_PROFILE",
"description" : "Test ss profile -- do not delete.",
"source" : {
"id" : 12,
"name" : "SmartSignal",
"description" : "SmartSignal",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"uuid" : "93E04CA186EE4BA496C1DBB304953067",
"isActive" : true
},
"type" : {
"id" : 8,
"name" : "Generic",
"description" : "Generic",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
"isActive" : true
},
"severity" : 1,
"isConsumable" : true,
"isTrip" : false,
"validateAsset" : true,
"isActiveProfile" : true,
"templateLinks" : [ ]
}
}
Note: API response will contain user owner details only when alarm is claimed. If you are generating alarm though back end process with user owner details then alarm state should be either in InProcess or Processed state. In this case API will return userOwner details.
Patching an Alarm
A PATCH
request is used to patch an alarm.
Request structure
Path | Type | Description |
---|---|---|
|
|
A list of patch operations to perform |
|
|
*Type of patch operation, possible values are: ADD, REPLACE and REMOVE |
|
|
*This is the alarm field to patch. In this case, alarmDisposition.name |
|
|
*The new value of the field |
*Required fields
Example CURL request 1
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4' -i -X PATCH \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]'
Example HTTP request 1
PATCH /alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 84
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]
Example response 1
HTTP/1.1 401 Unauthorized
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 215
{
"path" : "/alertmgmt",
"requestId" : "41a1c4b0-b7e2-46f8-a647-5c9e6a641c07",
"errorId" : "PATCH_UNAUTHORIZED",
"errorMessage" : "Unauthorized access patch call.:",
"timestamp" : "2023-12-12T05:36+0000"
}
Note: The Disposition/State of an alert cannot be updated if the alert is not claimed by the user. The above is an example for invalid patch operation.
Please refer Example HTTP request 2 for claim operation. ("value" field should contain UUID of logged in user)
Example HTTP request 2
PATCH /alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 107
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/userOwnerUuid",
"value" : "88c29d94-a058-4594-9b2c-d8e0e5924d48"
} ]
Example response 2
HTTP/1.1 200 OK
Example HTTP request 3
PATCH /alertmgmt/v3/alarms/B9FF7BD3C4354F989D802D0CB598F6E4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 95
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmState/name",
"value" : "In Process Maintenance"
} ]
Example response 3
HTTP/1.1 200 OK
Filter for Alarms
A POST
request is used to filter alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/filter' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0-82d3-4a9c-a444-96947e232436",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/alarms/filter HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 908
Host: www.predixapis.com
{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0-82d3-4a9c-a444-96947e232436",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
Name of the filter |
|
|
User ID of the filter |
|
|
If this filter is the default filter set, either true or false |
|
|
List of filter(s) |
|
|
Type of filter operation. Possible values are: contains |
|
|
Operand2 can be a filter text or dropdown values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" , |
|
|
Operand1 |
|
|
Class that builds the operand |
|
|
Name of the operand |
|
|
Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE |
|
|
Path of the operand |
|
|
Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE |
|
|
Operation Translations |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Aggregation of Alarms
A POST
request is used to aggregate alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 514
Host: www.predixapis.com
{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request Parameters
Parameter | Description |
---|---|
|
Comma separated List of Alarm Entity attributes are its descendent’s attributes |
|
Comma separated List of Aggregated Alarm Entity numeric attributes |
|
Field selected for orderBy eg: id-count |
|
ASC or DESC |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Get alarm count
A POST
request is used to get alarm count.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/count' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0-82d3-4a9c-a444-96947e232436",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/alarms/count HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 908
Host: www.predixapis.com
{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0-82d3-4a9c-a444-96947e232436",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
Name of the filter |
|
|
User ID of the filter |
|
|
If this filter is the default filter set, either true or false |
|
|
List of filter(s) |
|
|
Type of filter operation. Possible values are: contains |
|
|
Operand2 |
|
|
Operand1 |
|
|
Class that builds the operand |
|
|
Name of the operand |
|
|
Entity of the operand. Possible values are: USER |
|
|
Path of the operand |
|
|
Type of the operand. Possible values are: TEXT |
|
|
Operation Translations |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 282
{
"content" : [ ],
"pageable" : "INSTANCE",
"totalElements" : 0,
"totalPages" : 1,
"last" : true,
"first" : true,
"sort" : {
"sorted" : false,
"unsorted" : true,
"empty" : true
},
"numberOfElements" : 0,
"size" : 0,
"number" : 0,
"empty" : true
}
Delete Alerts by UUID/Id
A DELETE
request is used to delete alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/deleteAlerts' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"ids" : [ "50", "42" ]
}'
Example HTTP request
DELETE /alertmgmt/v3/alarms/deleteAlerts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 28
Host: www.predixapis.com
{
"ids" : [ "50", "42" ]
}
OR
DELETE /alertmgmt/v3/alarms/deleteAlerts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 90
Host: www.predixapis.com
{
"uuids" : [ "B9FF7BD3C4354F989D802D0CB598F6E4", "42133F8C09B1486E85CADBDB24626EFA" ]
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
This value can be "uuids", if it is list of UUID’s or "ids", if it is list of Alert ID’s. |
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 105
{
"InvalidIds" : [ 42 ],
"AccessDeniedIds" : [ ],
"message" : "Successfully deleted valid alerts"
}
OR
HTTP/1.1 404 Not Found
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 229
{
"path" : "/alertmgmt",
"requestId" : "d7e365ed-ad36-4a16-8f5c-edc17687a6ba",
"errorId" : "ALARMS_NOT_FOUND",
"errorMessage" : "Alarms not found:Could not find alarms to delete",
"timestamp" : "2023-12-12T05:37+0000"
}
Batch update alarm custom properties
A POST
request is used to batch update alarm custom properties.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/customproperties' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"alarmId" : null,
"uuid" : "BF8D76932B4345B0872CA02728DCF681",
"incident" : {
"incidentEventCount" : 2,
"firstOccurance" : "2019-06-04T12:23:00Z",
"lastOccurance" : "2019-06-04T12:23:00Z",
"lastProcessedTime" : "2019-06-04T12:23:00Z",
"lastObservationTime" : "2019-06-04T12:23:00Z",
"density" : "70.25"
}
} ]'
Example HTTP request
POST /alertmgmt/v3/alarms/customproperties HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 344
Host: www.predixapis.com
[ {
"alarmId" : null,
"uuid" : "BF8D76932B4345B0872CA02728DCF681",
"incident" : {
"incidentEventCount" : 2,
"firstOccurance" : "2019-06-04T12:23:00Z",
"lastOccurance" : "2019-06-04T12:23:00Z",
"lastProcessedTime" : "2019-06-04T12:23:00Z",
"lastObservationTime" : "2019-06-04T12:23:00Z",
"density" : "70.25"
}
} ]
Request Structure
Path | Type | Description |
---|---|---|
|
|
Id of the alert. This is an optional field. |
|
|
UUID of alert. |
|
|
Incident object of the alert in json format. |
|
|
Event count of the alert. |
|
|
Density of the incoming alert. Its a floating point value. |
|
|
Last processed time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format. |
|
|
Last observation time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format. |
|
|
First occurrence time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format. |
|
|
Last occurrence time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format. |
Example response
HTTP/1.1 200 OK
Create Recurring Alarm
A POST
request is used to create recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/recurring' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"startTime" : 1702359419141,
"endTime" : 1702373819141,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 0,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}'
Example HTTP request
POST /alertmgmt/v3/alarms/recurring HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 245
Host: www.predixapis.com
{
"startTime" : 1702359419141,
"endTime" : 1702373819141,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 0,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
true if its Internal Note, false otherwise |
|
|
Name of the alert |
|
|
Start time |
|
|
End time |
|
|
Frequency of recurrence |
|
|
Asset source ID |
|
|
Id |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 276
{
"createdon" : 1702359419323,
"startTime" : 1702359419141,
"endTime" : 1702373819141,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 3,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}
Get Recurring Alarm
A GET
request is used to get recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/recurringalarms' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/recurringalarms HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 836
[ {
"createdon" : 1702359419323,
"startTime" : 1702359419141,
"endTime" : 1702373819141,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 3,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
"createdon" : 1702358444795,
"startTime" : 1702358444734,
"endTime" : 1702372844734,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 2,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
"createdon" : 1702358409661,
"startTime" : 1702358409580,
"endTime" : 1702372809580,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 1,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
} ]
Delete Recurring Alarms by ID
A DELETE
request is used to delete recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/recurring/10' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
DELETE /alertmgmt/v3/alarms/recurring/10 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 404 Not Found
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 233
{
"path" : "/alertmgmt",
"requestId" : "7217939b-bf10-4f06-8615-920de82cbeb1",
"errorId" : "ALARM_NOT_FOUND",
"errorMessage" : "Alarm not found:no recurring alarm found with uuid 10",
"timestamp" : "2023-12-12T05:36+0000"
}
Get Audit for an Alert
A GET
request is used to get audits of an alert
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/audit/B9FF7BD3C4354F989D802D0CB598F6E4' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/audit/B9FF7BD3C4354F989D802D0CB598F6E4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 1808
[ {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Marked as In Process Maintenance",
"customProperties" : "{}",
"classifier" : "SUCCESS",
"actionType" : "Marked as In Process Maintenance",
"actionTimestamp" : 1702359418462,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
}, {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Claimed Alert",
"customProperties" : "{}",
"classifier" : "SUCCESS",
"actionType" : "Claimed Alert",
"actionTimestamp" : 1702359418161,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
}, {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Alert Created for test1234 test1234",
"customProperties" : "{\"assetName\":\"test1234\",\"assetId\":\"test1234\"}",
"classifier" : "SUCCESS",
"actionType" : "Alert Created",
"actionTimestamp" : 1702359416483,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
} ]
Create note for an Alarm
A POST
request is used to add note to an alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/notes' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"id" : 0,
"text" : "Notes 123",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false,
"parentEntityType" : "Alarm"
}'
Example HTTP request
POST /alertmgmt/v3/alarms/notes HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 181
Host: www.predixapis.com
{
"id" : 0,
"text" : "Notes 123",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false,
"parentEntityType" : "Alarm"
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
true if its Internal Note, false otherwise |
|
|
Type of parent alarm |
|
|
UUID of parent alarm |
|
|
Description of notes |
|
|
id |
|
|
NA |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 751
{
"id" : 49,
"uuid" : "DEBA5712C1FF47279A45940B2A25D8C0",
"text" : "Notes 123",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359419847,
"updatedOn" : 1702359419847,
"isDeletable" : true,
"parentEntityType" : "Alarm"
}
Get notes for an Alert
A GET
request is used to get notes for an alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/notes?parentEntityUuid=B9FF7BD3C4354F989D802D0CB598F6E4&sortBy=CREATE_DATE&sortOrder=DESC&isPrivateNote=false' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/notes?parentEntityUuid=B9FF7BD3C4354F989D802D0CB598F6E4&sortBy=CREATE_DATE&sortOrder=DESC&isPrivateNote=false HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 815
{
"data" : [ {
"id" : 49,
"uuid" : "DEBA5712C1FF47279A45940B2A25D8C0",
"text" : "Notes 123",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359419847,
"updatedOn" : 1702359419847,
"isDeletable" : true
} ],
"offset" : 0,
"total" : 1
}
Create batch notes for an Alert
A POST
request is used to create batch notes for an alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/notes/batch' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"id" : 0,
"text" : "first note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "second note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "third note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
} ]'
Example HTTP request
POST /alertmgmt/v3/alarms/notes/batch HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 460
Host: www.predixapis.com
[ {
"id" : 0,
"text" : "first note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "second note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "third note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"isPrivateNote" : false,
"isDeletable" : false
} ]
Request Structure
Path | Type | Description |
---|---|---|
|
|
true if its Internal Note, false otherwise |
|
|
true if its Internal Note, false otherwise |
|
|
ID of parent alarm |
|
|
Description of notes |
|
|
id |
|
|
NA |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 2170
[ {
"id" : 50,
"uuid" : "9182E4ADA0EF42D7B39BEC81A65791BD",
"text" : "first note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359420079,
"updatedOn" : 1702359420079,
"isDeletable" : true
}, {
"id" : 51,
"uuid" : "85458FDAE4CF4D97BC0293BC4859F63E",
"text" : "second note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359420082,
"updatedOn" : 1702359420082,
"isDeletable" : true
}, {
"id" : 52,
"uuid" : "C0CD9AF729844862AB2590977690474D",
"text" : "third note",
"parentEntityUuid" : "B9FF7BD3C4354F989D802D0CB598F6E4",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359420082,
"updatedOn" : 1702359420082,
"isDeletable" : true
} ]
Add attachment for an Alert
A POST
request is used to add attachment for an alert
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/attachments?parentEntityUuid=B9FF7BD3C4354F989D802D0CB598F6E4&parentEntityType=Alarm&name=filename' -i -X POST \
-H 'Content-Type: multipart/form-data' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-F 'file=@blog.txt;type=text/plain' \
-F 'parentEntityUuid=B9FF7BD3C4354F989D802D0CB598F6E4' \
-F 'parentEntityType=Alarm' \
-F 'name=filename'
Example HTTP request
POST /alertmgmt/v3/alarms/attachments?parentEntityUuid=B9FF7BD3C4354F989D802D0CB598F6E4&parentEntityType=Alarm&name=filename HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=parentEntityUuid
B9FF7BD3C4354F989D802D0CB598F6E4
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=parentEntityType
Alarm
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=name
filename
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=blog.txt
Content-Type: text/plain
text
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 641
{
"id" : 344519,
"uuid" : "e4e1b5c4-1dae-4d48-919a-fde22c7eab78",
"name" : "blog.txt",
"url" : "https://apm-blob-storage-svc-rc.int-app.aws-usw02-pr.predix.io/v3/attachments/e4e1b5c4-1dae-4d48-919a-fde22c7eab78/download",
"size" : 6,
"parentEntityUuid" : "B9D6B2202A304CC1B82F14B506689D22",
"parentEntityType" : "Alarm",
"userOwnerUuid" : "e9b768ae-8099-4578-b39b-c9ca52fe9b5e",
"createdOn" : 1511548008707,
"updatedOn" : 1511548008707,
"userOwner" : {
"firstName" : "alertsdevg",
"lastName" : "smokeuser",
"uuid" : "e9b768ae-8099-4578-b39b-c9ca52fe9b5e",
"userName" : null
},
"isDeletable" : true
}
Get attachment for an Alert
A GET
request is used to get attachment for an alert
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/attachments?parentEntityUuid=test-parent-uuid&sortBy=CREATE_DATE&sortOrder=ASC' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/attachments?parentEntityUuid=test-parent-uuid&sortBy=CREATE_DATE&sortOrder=ASC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 621
{
"id" : 66069,
"uuid" : "test-attachment-uuid",
"name" : "sample1.jpg",
"url" : "https://apm-blob-storage-dev.run.asv-pr.ice.predix.io/v3/attachments/ccb8deb8-e3ce-485d-a11b-87165ad3a7eb/download",
"size" : 185759,
"parentEntityUuid" : "B9D6B2202A304CC1B82F14B506689D22",
"parentEntityType" : "Alarm",
"userOwnerUuid" : "5b97c6aa-1d7a-43f0-880d-7ff4e594f663",
"createdOn" : 1494488607935,
"updatedOn" : 1494488607935,
"userOwner" : {
"firstName" : "sample2",
"lastName" : "smokeuser",
"uuid" : "5b97c6aa-1d7a-43f0-880d-7ff4e594f663",
"userName" : null
},
"isDeletable" : false
}
Create latch config
A PUT
request is used to create custom attribute.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/latchconfig' -i -X PUT \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"entityTypeSubscriptions" : {
"ALERT" : [ {
"complexWatchable" : {
"entityType" : "ALERT",
"trigger" : "ALERT_CREATED",
"fieldExpressions" : {
"wizardFilters" : [ ],
"filters" : [ {
"operation" : "eq",
"operand2" : [ "2" ],
"operand1" : {
"displayName" : "Severity",
"path" : "alarm.severity",
"type" : "NUMBER",
"entity" : "ALARM",
"tenantId" : null,
"possibleOperations" : null,
"builderClass" : "com.ge.apm.filtering.impl.NumberFilterQueryBuilder",
"operationTranslations" : null,
"operand2Translations" : null
}
} ]
},
"actionTypeId" : 2,
"actionValue" : {
"name" : "LATCH_ALERT"
}
}
} ]
}
}'
Example HTTP request
PUT /alertmgmt/v3/alarms/latchconfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 891
Host: www.predixapis.com
{
"entityTypeSubscriptions" : {
"ALERT" : [ {
"complexWatchable" : {
"entityType" : "ALERT",
"trigger" : "ALERT_CREATED",
"fieldExpressions" : {
"wizardFilters" : [ ],
"filters" : [ {
"operation" : "eq",
"operand2" : [ "2" ],
"operand1" : {
"displayName" : "Severity",
"path" : "alarm.severity",
"type" : "NUMBER",
"entity" : "ALARM",
"tenantId" : null,
"possibleOperations" : null,
"builderClass" : "com.ge.apm.filtering.impl.NumberFilterQueryBuilder",
"operationTranslations" : null,
"operand2Translations" : null
}
} ]
},
"actionTypeId" : 2,
"actionValue" : {
"name" : "LATCH_ALERT"
}
}
} ]
}
}
Request structure
Path | Type | Description |
---|---|---|
|
|
Subscriptions |
|
|
Value is ALERT or CASES depending on where latched alert needs to be created |
|
|
Collection of fields and filters required to create latched alert |
|
|
Value can be ALERT or CASES depending on the rule where latched alert needs to be created |
|
|
Either ALERT_CREATED or ALERT_DISPOSITION_UPDATED depending on the condition |
|
|
Set of filters that can be applied→ Severity, Source, Alert Type, Alert Name |
|
|
Id of action type |
|
|
Action to be taken upon creation |
*Required fields
Example response
HTTP/1.1 200 OK
Getting Tenant Configurations
A GET
request is used get tenant configurations.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/tenantConfig' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 188
{
"disposition" : [ {
"id" : 1194,
"name" : "Alarm-Disposition-Name",
"uuid" : "uuid",
"isActive" : true,
"isDeleted" : false,
"displayOrder" : 2147483647
} ]
}
Response structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
name of tenant configuration |
|
|
Unique ID of tenant configuration |
|
|
false if tenant configuration is deprecated, true otherwise |
|
|
true if tenant configuration deleted, false otherwise |
|
|
display order for tenant configuration |
Create Tenant Configuration
A POST
request is used to create tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v3/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 178
Host: www.predixapis.com
{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
name of tenant configuration |
|
|
description of disposition |
|
|
Unique ID of disposition |
|
|
Language of disposition |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Update Tenant Configuration
A POST
request is used to update tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"id" : 1194,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v3/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 157
Host: www.predixapis.com
{
"disposition" : [ {
"id" : 1194,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
Description of the disposition |
|
|
uuid of the disposition |
|
|
language of name |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Getting Custom Attributes
A GET
request is used get custom attributes.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/customattribute' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186
[ {
"id" : 4,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
} ]
Response structure
Path | Type | Description |
---|---|---|
|
|
id of custom attribute |
|
|
variable name of custom attribute |
|
|
display name of custom attribute |
|
|
the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
visibility of custom attribute on front end |
|
|
min value of NUMBER type custom attribute |
|
|
max value of NUMBER type custom attribute |
Create Custom Attribute
A POST
request is used to create custom attribute.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/alarms/customattribute' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}'
Example HTTP request
POST /alertmgmt/v3/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 182
Host: www.predixapis.com
{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*Custom Attribute Id |
|
|
*The name that will represent the custom attribute value. Cannot already exist in the tenant. |
|
|
*The display name of the custom attribute, which will be shown on the front-end. |
|
|
*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
*Boolean whether the custom attribute will be displayed on the front-end. |
|
|
*The minimum value the custom attribute can be (only applies to type NUMBER). |
|
|
*The maximum value the custom attribute can be (only applies to type NUMBER). |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 182
{
"id" : 4,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
V3/tenants/{tenantUuid} APIs
Creating a SmartSignal Alarm
A POST
request is used to create alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 1410
Host: www.predixapis.com
{
"severity" : 3,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"isActive" : true,
"id" : 0,
"latchCount" : 1,
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
}
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*This should match the name of the Alarm Profile that already exists in APM |
|
|
*Asset UUID, which is already ingested in APM Asset |
|
|
Event Generated Date, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC is time at which the event was generated. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
Time when alert was received by APM system, in YYYY-MM-DDTHH:MM:SS.SSSZ UTC. Example:2015-10-27T07:00:00.000Z. If it is blank, it will store the current time in UTC! |
|
|
By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten. |
|
|
Key value pairs of Sensor:Value information that triggered the alarm. Example:{"BRG_1_VIB_2_1X_AMP":"53.95484042","BRG_1_VIB_1_OVERALL":"62.4367112"} |
|
|
Incident object contains more details like the number of time the alarm was triggered, datetime of first and last occurrence. First occurrence and last occurrence should be in YYYY-MM-DDTHH:MM:SS.SSSZ UTC format. Example:{"incidentEventCount":"125","firstOccurance":"2015-08-11T19:07:00.000Z","lastOccurance":"2015-08-19T15:47:00.000Z"} |
|
|
This contains the tag information that an analyst may be interested of in analyzing the alarm. Example:tagsOfInterest":[{"uuid":"e6d65833-028f-4d0f-b0cc-8334bdcf2d53","isContributing":false,"displayGrouped":true,"displayGroupedName":"DRIVER_LOAD","uom":"KLB/HR"},{"uuid":"8288f357-4ab2-4e99-ab14-c0717b27fe5b","isContributing":false,"displayGrouped":true,"displayGroupedName":"PUMP_SPEED","uom":"rpm"}] |
|
|
Tenant under which this alarm will be created and is accessible |
|
|
id |
|
|
isActive |
|
|
if the alarm is a recurring alarm |
|
|
if the alarm has limited visibility |
|
|
Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored |
|
|
disablePrefetch flag |
|
|
This days calculated between Event Time and Alert Creation time |
|
|
This flag used to identify whether alert is Stale or Not |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 196
{
"uuid" : "EF3016B74D0D4C73BF39569110781A14",
"links" : [ {
"rel" : "self",
"href" : "/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14"
} ]
}
Getting an Alarm by UUID
A GET
request is used to get alarm details.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 4947
{
"severity" : 3,
"isTrip" : false,
"timeseriesCached" : false,
"name" : "TEST_SS_PROFILE",
"eventStart" : 1439320020000,
"storageReceiveTime" : 1439320020000,
"associatedMonitoredEntityUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"type" : "Generic",
"source" : "SmartSignal",
"templated" : true,
"templateName" : "TEST_SS_PROFILE",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"recurring" : false,
"limitedVisibility" : true,
"uuid" : "EF3016B74D0D4C73BF39569110781A14",
"isActive" : true,
"createdOn" : 1702359454815,
"updatedOn" : 1702359454894,
"sourceKey" : "a74f4e09-b47f-4902-abde-4f3f1acebfd4",
"id" : 52,
"alarmState" : {
"id" : 1,
"uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
"isActive" : true,
"createdOn" : 1702357679363,
"locale" : "en-US",
"tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"name" : "Ready",
"description" : "Ready"
},
"alarmAsset" : {
"id" : 4,
"uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"isActive" : true,
"createdOn" : 1702358408100,
"updatedOn" : 1702358408100,
"assetUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"assetName" : "test1234",
"assetNameLower" : "test1234",
"siteName" : "CONSTELLATION",
"siteNameLower" : "constellation",
"assetCustomerName" : "SS Test Enterprise",
"assetCustomerNameLower" : "ss test enterprise",
"assetSourceKey" : "test1234",
"assetSourceKeyLower" : "test1234",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"assetTimeZone" : "",
"parentName" : "CONSTELLATION",
"parentNameLower" : "constellation",
"criticalityDescription" : "",
"criticalityValue" : 0,
"criticalityColor" : ""
},
"processorClassName" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"latchCount" : 1,
"lastOccurrence" : 1439999220000,
"previousSeverity" : 3,
"firstOccurrence" : 1439320020000,
"lastProcessedTime" : 1439320020000,
"lastObservationTime" : 1439320020000,
"analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
"disablePrefetch" : false,
"staleAlertDays" : 0,
"isStaleAlert" : false,
"trip" : false,
"scanGroupData" : {
"BRG_1_VIB_2_1X_AMP" : "53.95484042",
"BRG_1_VIB_1_OVERALL" : "62.4367112",
"BRG_1_VIB_2_OVERALL" : "57.80885233",
"BRG_1_VIB_2_1X_PHASE" : "305.013721",
"BRG_1_VIB_1_1X_AMP" : "59.19077386"
},
"tagsOfInterest" : [ {
"uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "DRIVER_LOAD",
"uom" : "KLB/HR"
}, {
"uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "PUMP_SPEED",
"uom" : "rpm"
}, {
"uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137",
"isContributing" : false,
"displayGrouped" : true,
"displayGroupedName" : "LUBE_OIL_TEMP",
"uom" : "Celsius"
} ],
"incident" : {
"incidentEventCount" : "1",
"firstOccurance" : "2015-08-11T19:07:00.000Z",
"lastOccurance" : "2015-08-19T15:47:00.000Z"
},
"associatedMonitoredEntity" : {
"uuid" : "/assets/468fdf6c-2d44-35b8-957d-19b104b70599",
"equipmentId" : "test1234",
"name" : "test1234",
"enterprise" : {
"name" : "SS Test Enterprise"
},
"site" : {
"name" : "CONSTELLATION",
"address" : { }
},
"contact" : {
"name" : "test1234"
},
"assetType" : {
"uri" : "/assetTypes/d395b287-0730-395b-bc1f-2d9ed0dbf3cf",
"sourcekey" : "test1234",
"name" : "test1234"
},
"reservedAttributes" : {
"make" : null,
"maintenancecriticalityriskscore" : null,
"faultmode" : null
},
"userPermissions" : [ "Manage Alerts", "View Limited Visibility Alerts" ]
},
"alarmProfile" : {
"id" : 49,
"createdOn" : 1469742971359,
"updatedOn" : 1469664000000,
"uuid" : "9CB257D33B674C64804EDCE48C6CF75A",
"isActive" : true,
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"name" : "TEST_SS_PROFILE",
"description" : "Test ss profile -- do not delete.",
"source" : {
"id" : 12,
"name" : "SmartSignal",
"description" : "SmartSignal",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor",
"uuid" : "93E04CA186EE4BA496C1DBB304953067",
"isActive" : true
},
"type" : {
"id" : 8,
"name" : "Generic",
"description" : "Generic",
"tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
"uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
"isActive" : true
},
"severity" : 1,
"isConsumable" : true,
"isTrip" : false,
"validateAsset" : true,
"isActiveProfile" : true,
"templateLinks" : [ ]
}
}
Note: API response will contain user owner details only when alarm is claimed. If you are generating alarm though back end process with user owner details then alarm state should be either in InProcess or Processed state. In this case API will return userOwner details.
Patching an Alarm
A PATCH
request is used to patch an alarm.
Request structure
Path | Type | Description |
---|---|---|
|
|
A list of patch operations to perform |
|
|
*Type of patch operation, possible values are: ADD, REPLACE and REMOVE |
|
|
*This is the alarm field to patch. In this case, alarmDisposition.name |
|
|
*The new value of the field |
*Required fields
Example CURL request 1
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14' -i -X PATCH \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]'
Example HTTP request 1
PATCH /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 84
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmDisposition/name",
"value" : "Valid"
} ]
Example response 1
HTTP/1.1 401 Unauthorized
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 215
{
"path" : "/alertmgmt",
"requestId" : "8b981f78-ae10-445a-9ec0-f74b19bdb304",
"errorId" : "PATCH_UNAUTHORIZED",
"errorMessage" : "Unauthorized access patch call.:",
"timestamp" : "2023-12-12T05:37+0000"
}
Note: The Disposition/State of an alert cannot be updated if the alert is not claimed by the user. The above is an example for invalid patch operation.
Please refer Example HTTP request 2 for claim operation. ("value" field should contain UUID of logged in user)
Example HTTP request 2
PATCH /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 107
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/userOwnerUuid",
"value" : "88c29d94-a058-4594-9b2c-d8e0e5924d48"
} ]
Example response 2
HTTP/1.1 200 OK
Example HTTP request 3
PATCH /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/EF3016B74D0D4C73BF39569110781A14 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 95
Host: www.predixapis.com
[ {
"op" : "REPLACE",
"path" : "/alarmState/name",
"value" : "In Process Maintenance"
} ]
Example response 3
HTTP/1.1 200 OK
Filter for Alarms
A POST
request is used to filter alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/filter' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/filter HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 880
Host: www.predixapis.com
{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
Name of the filter |
|
|
User ID of the filter |
|
|
If this filter is the default filter set, either true or false |
|
|
List of filter(s) |
|
|
Type of filter operation. Possible values are: contains |
|
|
Operand2 can be a filter text or dropdown values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" , |
|
|
Operand1 |
|
|
Class that builds the operand |
|
|
Name of the operand |
|
|
Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE |
|
|
Path of the operand |
|
|
Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE |
|
|
Operation Translations |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Aggregation of Alarms
A POST
request is used to aggregate alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/filter?fields=severity&aggregatedFields=id-count&sortField=id-count&sortOrder=DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 514
Host: www.predixapis.com
{
"name" : "",
"userId" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "eq",
"operand2" : "Inverter1-ASSET-TYPE1",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Asset Id",
"entity" : "ASSET",
"path" : "alarm.associatedMonitoredEntityUuid",
"type" : "TEXT",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request Parameters
Parameter | Description |
---|---|
|
Comma separated List of Alarm Entity attributes are its descendent’s attributes |
|
Comma separated List of Aggregated Alarm Entity numeric attributes |
|
Field selected for orderBy eg: id-count |
|
ASC or DESC |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 203
{
"number" : 0,
"last" : true,
"size" : 0,
"numberOfElements" : 0,
"universalAssetData" : null,
"totalPages" : 1,
"sort" : null,
"first" : true,
"content" : [ ],
"totalElements" : 0
}
Getting Tenant Configurations
A GET
request is used get tenant configurations.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 188
{
"disposition" : [ {
"id" : 1287,
"name" : "Alarm-Disposition-Name",
"uuid" : "uuid",
"isActive" : true,
"isDeleted" : false,
"displayOrder" : 2147483647
} ]
}
Response structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
name of tenant configuration |
|
|
Unique ID of tenant configuration |
|
|
false if tenant configuration is deprecated, true otherwise |
|
|
true if tenant configuration deleted, false otherwise |
|
|
display order for tenant configuration |
Get alarm count
A POST
request is used to get alarm count.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/count' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/count HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 880
Host: www.predixapis.com
{
"name" : "",
"userId" : "3361549A50A8455DA72FFFDD2718FFA0",
"defaultFilterSet" : false,
"filters" : [ {
"operation" : "contains",
"operand2" : "test-user",
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Owner",
"entity" : "USER",
"path" : "alarm.user",
"type" : "TEXT",
"operationTranslations" : {
"contains" : "filters.operation.contains"
}
}
}, {
"operation" : "eq",
"operand2" : [ "Ready", "In Process", "Processed" ],
"operand1" : {
"builderClass" : "com.ge.apm.filtering.impl.SimpleFilterQueryBuilder",
"displayName" : "Status",
"entity" : "ALARM",
"path" : "alarm.alarmState.name",
"type" : "STRING",
"operationTranslations" : {
"eq" : "filters.operation.equals"
}
}
} ]
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
Name of the filter |
|
|
User ID of the filter |
|
|
If this filter is the default filter set, either true or false |
|
|
List of filter(s) |
|
|
Type of filter operation. Possible values are: contains |
|
|
Operand2 |
|
|
Operand1 |
|
|
Class that builds the operand |
|
|
Name of the operand |
|
|
Entity of the operand. Possible values are: USER |
|
|
Path of the operand |
|
|
Type of the operand. Possible values are: TEXT |
|
|
Operation Translations |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 282
{
"content" : [ ],
"pageable" : "INSTANCE",
"totalElements" : 0,
"totalPages" : 1,
"last" : true,
"first" : true,
"sort" : {
"sorted" : false,
"unsorted" : true,
"empty" : true
},
"numberOfElements" : 0,
"size" : 0,
"number" : 0,
"empty" : true
}
Delete Alerts by UUID/Id
A DELETE
request is used to delete alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/deleteAlerts' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"ids" : [ "52", "42" ]
}'
Example HTTP request
DELETE /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/deleteAlerts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 28
Host: www.predixapis.com
{
"ids" : [ "52", "42" ]
}
OR
DELETE /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/deleteAlerts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 90
Host: www.predixapis.com
{
"uuids" : [ "EF3016B74D0D4C73BF39569110781A14", "42133F8C09B1486E85CADBDB24626EFA" ]
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
This value can be "uuids", if it is list of UUID’s or "ids", if it is list of Alert ID’s. |
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 105
{
"InvalidIds" : [ 42 ],
"AccessDeniedIds" : [ ],
"message" : "Successfully deleted valid alerts"
}
OR
HTTP/1.1 404 Not Found
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 229
{
"path" : "/alertmgmt",
"requestId" : "fd748c19-0075-4bfa-9de7-a74d53a003c1",
"errorId" : "ALARMS_NOT_FOUND",
"errorMessage" : "Alarms not found:Could not find alarms to delete",
"timestamp" : "2023-12-12T05:37+0000"
}
Create Recurring Alarm
A POST
request is used to create recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurring' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"startTime" : 1702359455954,
"endTime" : 1702373855954,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 0,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurring HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 245
Host: www.predixapis.com
{
"startTime" : 1702359455954,
"endTime" : 1702373855954,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 0,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
true if its Internal Note, false otherwise |
|
|
Name of the alert |
|
|
Start time |
|
|
End time |
|
|
Frequency of recurrence |
|
|
Asset source ID |
|
|
Id |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 276
{
"createdon" : 1702359456048,
"startTime" : 1702359455954,
"endTime" : 1702373855954,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 4,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}
Get Recurring Alarm
A GET
request is used to get recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurringalarms' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurringalarms HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 1114
[ {
"createdon" : 1702359456048,
"startTime" : 1702359455954,
"endTime" : 1702373855954,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 4,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
"createdon" : 1702359419323,
"startTime" : 1702359419141,
"endTime" : 1702373819141,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 3,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
"createdon" : 1702358444795,
"startTime" : 1702358444734,
"endTime" : 1702372844734,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 2,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
"createdon" : 1702358409661,
"startTime" : 1702358409580,
"endTime" : 1702372809580,
"frequency" : 2,
"alertName" : "KM-Test-Alert",
"assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
"id" : 1,
"assetSourceId" : "Inverter1-ASSET-TYPE1"
} ]
Delete Recurring Alarms by ID
A DELETE
request is used to delete recurring alarms.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurring/10' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
DELETE /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/recurring/10 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 404 Not Found
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 233
{
"path" : "/alertmgmt",
"requestId" : "2c4585fd-6e1c-419d-9153-80e71d7dbb51",
"errorId" : "ALARM_NOT_FOUND",
"errorMessage" : "Alarm not found:no recurring alarm found with uuid 10",
"timestamp" : "2023-12-12T05:37+0000"
}
Get Audit for an Alert
A GET
request is used to get audits for an alert.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/audit/EF3016B74D0D4C73BF39569110781A14' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/audit/EF3016B74D0D4C73BF39569110781A14 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 1808
[ {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "EF3016B74D0D4C73BF39569110781A14",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Marked as In Process Maintenance",
"customProperties" : "{}",
"classifier" : "SUCCESS",
"actionType" : "Marked as In Process Maintenance",
"actionTimestamp" : 1702359455540,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
}, {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "EF3016B74D0D4C73BF39569110781A14",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Claimed Alert",
"customProperties" : "{}",
"classifier" : "SUCCESS",
"actionType" : "Claimed Alert",
"actionTimestamp" : 1702359455435,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
}, {
"actorUUID" : "not available",
"actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
"actorDisplayName" : "test user",
"tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"alertUUID" : "EF3016B74D0D4C73BF39569110781A14",
"alertName" : "TEST_SS_PROFILE",
"assetId" : "test1234",
"assetName" : "test1234",
"description" : "Alert Created for test1234 test1234",
"customProperties" : "{\"assetName\":\"test1234\",\"assetId\":\"test1234\"}",
"classifier" : "SUCCESS",
"actionType" : "Alert Created",
"actionTimestamp" : 1702359454926,
"alertCreationTimestamp" : 1439320020000,
"uploaded" : false
} ]
Create note for an Alert
A POST
request is used to create notes for an alarm.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"id" : 0,
"text" : "Notes 123",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false,
"parentEntityType" : "Alarm"
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 181
Host: www.predixapis.com
{
"id" : 0,
"text" : "Notes 123",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false,
"parentEntityType" : "Alarm"
}
Request Structure
Path | Type | Description |
---|---|---|
|
|
true if its Internal Note, false otherwise |
|
|
Type |
|
|
ID of parent alarm |
|
|
Description of notes |
|
|
id |
|
|
NA |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 751
{
"id" : 53,
"uuid" : "0B1DB52CD809450798A6DFEAB21F443A",
"text" : "Notes 123",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359456292,
"updatedOn" : 1702359456292,
"isDeletable" : true,
"parentEntityType" : "Alarm"
}
Get notes for an Alert
A GET
request is used to get notes for an alarm
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes?parentEntityUuid=EF3016B74D0D4C73BF39569110781A14&sortBy=CREATE_DATE&sortOrder=DESC&isPrivateNote=false' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes?parentEntityUuid=EF3016B74D0D4C73BF39569110781A14&sortBy=CREATE_DATE&sortOrder=DESC&isPrivateNote=false HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 815
{
"data" : [ {
"id" : 53,
"uuid" : "0B1DB52CD809450798A6DFEAB21F443A",
"text" : "Notes 123",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359456292,
"updatedOn" : 1702359456292,
"isDeletable" : true
} ],
"offset" : 0,
"total" : 1
}
Create batch notes for an Alert
A POST
request is used to create create batch notes for an alarm
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes/batch' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '[ {
"id" : 0,
"text" : "first note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "second note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "third note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
} ]'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes/batch HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 460
Host: www.predixapis.com
[ {
"id" : 0,
"text" : "first note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "second note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
}, {
"id" : 0,
"text" : "third note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"isPrivateNote" : false,
"isDeletable" : false
} ]
Request Structure
Path | Type | Description |
---|---|---|
|
|
|
|
|
true if its Internal Note, false otherwise |
|
|
ID of parent alarm |
|
|
Description of notes |
|
|
id |
|
|
NA |
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 2170
[ {
"id" : 54,
"uuid" : "F1392C11BE4A44EDBFD0132AFC97F6C2",
"text" : "first note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359456454,
"updatedOn" : 1702359456454,
"isDeletable" : true
}, {
"id" : 55,
"uuid" : "9D59CFDE4E8D4E6E96AE3FA748DEF5D1",
"text" : "second note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359456454,
"updatedOn" : 1702359456454,
"isDeletable" : true
}, {
"id" : 56,
"uuid" : "4F37394FBB0944F2A3D4DC47F26AADCB",
"text" : "third note",
"parentEntityUuid" : "EF3016B74D0D4C73BF39569110781A14",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"userOwner" : {
"uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"name" : "testuser2",
"userFullName" : "test user",
"firstName" : "test",
"lastName" : "user",
"tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
"id" : 3,
"isActive" : true,
"createdOn" : 1702358253814,
"updatedOn" : 1702358253814
},
"userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
"isPrivateNote" : false,
"createdOn" : 1702359456454,
"updatedOn" : 1702359456454,
"isDeletable" : true
} ]
Add attachment for an Alert
A POST
request is used to add attachment for an alert
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/attachments?parentEntityUuid=EF3016B74D0D4C73BF39569110781A14&parentEntityType=Alarm&name=filename' -i -X POST \
-H 'Content-Type: multipart/form-data' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-F 'file=@blog.txt;type=text/plain' \
-F 'parentEntityUuid=EF3016B74D0D4C73BF39569110781A14' \
-F 'parentEntityType=Alarm' \
-F 'name=filename'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/attachments?parentEntityUuid=EF3016B74D0D4C73BF39569110781A14&parentEntityType=Alarm&name=filename HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=parentEntityUuid
EF3016B74D0D4C73BF39569110781A14
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=parentEntityType
Alarm
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=name
filename
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=blog.txt
Content-Type: text/plain
text
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 641
{
"id" : 344519,
"uuid" : "e4e1b5c4-1dae-4d48-919a-fde22c7eab78",
"name" : "blog.txt",
"url" : "https://apm-blob-storage-svc-rc.int-app.aws-usw02-pr.predix.io/v3/attachments/e4e1b5c4-1dae-4d48-919a-fde22c7eab78/download",
"size" : 6,
"parentEntityUuid" : "B9D6B2202A304CC1B82F14B506689D22",
"parentEntityType" : "Alarm",
"userOwnerUuid" : "e9b768ae-8099-4578-b39b-c9ca52fe9b5e",
"createdOn" : 1511548008707,
"updatedOn" : 1511548008707,
"userOwner" : {
"firstName" : "alertsdevg",
"lastName" : "smokeuser",
"uuid" : "e9b768ae-8099-4578-b39b-c9ca52fe9b5e",
"userName" : null
},
"isDeletable" : true
}
Get attachment for an Alert
A GET
request is used to get attachment for an alert
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/attachments?parentEntityUuid=test-parent-uuid&sortBy=CREATE_DATE&sortOrder=ASC' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
*Required fields
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 621
{
"id" : 66069,
"uuid" : "test-attachment-uuid",
"name" : "sample1.jpg",
"url" : "https://apm-blob-storage-dev.run.asv-pr.ice.predix.io/v3/attachments/ccb8deb8-e3ce-485d-a11b-87165ad3a7eb/download",
"size" : 185759,
"parentEntityUuid" : "B9D6B2202A304CC1B82F14B506689D22",
"parentEntityType" : "Alarm",
"userOwnerUuid" : "5b97c6aa-1d7a-43f0-880d-7ff4e594f663",
"createdOn" : 1494488607935,
"updatedOn" : 1494488607935,
"userOwner" : {
"firstName" : "sample2",
"lastName" : "smokeuser",
"uuid" : "5b97c6aa-1d7a-43f0-880d-7ff4e594f663",
"userName" : null
},
"isDeletable" : false
}
Create Tenant Configuration
A POST
request is used to create tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 178
Host: www.predixapis.com
{
"disposition" : [ {
"name" : "Alarm-Disposition-Name",
"description" : "alarm-description",
"isActive" : true,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
name of tenant configuration |
|
|
description of disposition |
|
|
Unique ID of disposition |
|
|
Language of disposition |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Update Tenant Configuration
A POST
request is used to update tenant configuration.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"disposition" : [ {
"id" : 1287,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/tenantConfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 157
Host: www.predixapis.com
{
"disposition" : [ {
"id" : 1287,
"description" : "alarm-description",
"isActive" : false,
"uuid" : "uuid",
"locale" : "en-US"
} ]
}
Request structure
Path | Type | Description |
---|---|---|
|
|
id of tenant configuration |
|
|
Description of the disposition |
|
|
uuid of the disposition |
|
|
language of name |
|
|
false if tenant configuration is deprecated, true otherwise |
*Required fields
Example response
HTTP/1.1 200 OK
Getting Custom Attributes
A GET
request is used get custom attributes.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/customattribute' -i -X GET \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac'
Example HTTP request
GET /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Host: www.predixapis.com
Example response
HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186
[ {
"id" : 6,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
} ]
Response structure
Path | Type | Description |
---|---|---|
|
|
id of custom attribute |
|
|
variable name of custom attribute |
|
|
display name of custom attribute |
|
|
the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
visibility of custom attribute on front end |
|
|
min value of NUMBER type custom attribute |
|
|
max value of NUMBER type custom attribute |
Create Custom Attribute
A POST
request is used to create custom attribute.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/customattribute' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}'
Example HTTP request
POST /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/customattribute HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 182
Host: www.predixapis.com
{
"id" : 0,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
Request structure
Path | Type | Description |
---|---|---|
|
|
*Custom Attribute Id |
|
|
*The name that will represent the custom attribute value. Cannot already exist in the tenant. |
|
|
*The display name of the custom attribute, which will be shown on the front-end. |
|
|
*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL). |
|
|
*Boolean whether the custom attribute will be displayed on the front-end. |
|
|
*The minimum value the custom attribute can be (only applies to type NUMBER). |
|
|
*The maximum value the custom attribute can be (only applies to type NUMBER). |
*Required fields
Example response
HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 182
{
"id" : 6,
"attributeName" : "testAttribute",
"displayName" : "Test Attribute",
"attributeType" : "NUMBER",
"visibility" : true,
"minValue" : 0.0,
"maxValue" : 100.0
}
Create latch config
A PUT
request is used to create custom attribute.
Example CURL request
$ curl 'https://www.predixapis.com/alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/latchconfig' -i -X PUT \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw' \
-H 'tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac' \
-d '{
"entityTypeSubscriptions" : {
"ALERT" : [ {
"complexWatchable" : {
"entityType" : "ALERT",
"trigger" : "ALERT_CREATED",
"fieldExpressions" : {
"wizardFilters" : [ ],
"filters" : [ {
"operation" : "eq",
"operand2" : [ "2" ],
"operand1" : {
"displayName" : "Severity",
"path" : "alarm.severity",
"type" : "NUMBER",
"entity" : "ALARM",
"tenantId" : null,
"possibleOperations" : null,
"builderClass" : "com.ge.apm.filtering.impl.NumberFilterQueryBuilder",
"operationTranslations" : null,
"operand2Translations" : null
}
} ]
},
"actionTypeId" : 2,
"actionValue" : {
"name" : "LATCH_ALERT"
}
}
} ]
}
}'
Example HTTP request
PUT /alertmgmt/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/latchconfig HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzODI2YjdlNjllMDE0Y2UxYWMyM2MzMzIwNzgyYzZhMyIsInN1YiI6IjQwNzc1MmYwLTc4ZTktNGQyOC05YTJkLTM2NGUxMjQxMmE3MSIsInNjb3BlIjpbInBhc3N3b3JkLndyaXRlIiwib3BlbmlkIl0sImNsaWVudF9pZCI6ImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJjaWQiOiJpbmdlc3Rvci5lYTFhMDI0NS0xNzU4LTRlNjYtYWJmMC1mMjUzOTU2YTc4MjAuZjhkYWFhNTAtMGE4Zi00ZTVlLWFmMmEtOTI2MTIwNDA0YmExIiwiYXpwIjoiaW5nZXN0b3IuZWExYTAyNDUtMTc1OC00ZTY2LWFiZjAtZjI1Mzk1NmE3ODIwLmY4ZGFhYTUwLTBhOGYtNGU1ZS1hZjJhLTkyNjEyMDQwNGJhMSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfaWQiOiI0MDc3NTJmMC03OGU5LTRkMjgtOWEyZC0zNjRlMTI0MTJhNzEiLCJvcmlnaW4iOiJ1YWEiLCJ1c2VyX25hbWUiOiJmNzQzYjdlZi00MmRmLTRkN2UtODlkZC05MGRjM2I1M2IwYWNfaW5nZXN0b3IiLCJlbWFpbCI6ImY3NDNiN2VmLTQyZGYtNGQ3ZS04OWRkLTkwZGMzYjUzYjBhY19pbmdlc3RvckBzdHVmLXJjLnJ1bi5hc3YtcHIuaWNlLnByZWRpeC5pbyIsImF1dGhfdGltZSI6MTQ3OTgwMjU4MSwicmV2X3NpZyI6IjgzM2U3MzFkIiwiaWF0IjoxNDc5ODAyNTgxLCJleHAiOjk5OTk5OTk5OTksImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA0OS9vYXV0aC90b2tlbiIsInppZCI6IjQxMjZiMjdiLTY4NjAtNDhlZS05ZGMxLTljYmEzMTNlYWM5ZiIsImF1ZCI6WyJwYXNzd29yZCIsImluZ2VzdG9yLmVhMWEwMjQ1LTE3NTgtNGU2Ni1hYmYwLWYyNTM5NTZhNzgyMC5mOGRhYWE1MC0wYThmLTRlNWUtYWYyYS05MjYxMjA0MDRiYTEiLCJvcGVuaWQiXX0.OoIy1PLcJoklNFaQkU05u61SI9QyfNlWQm1yO3R7uHeY-NnY9l09bMHNzOis0miymm7bSE5FFz0ga35F7IH3WXUksFI3G34ddnquLO43YlGFqbbAolTqILbb06CL_rWUJvFdvXx779tGlh9FsX21Q3ccM-g3HBgsMJFiElkF4WFIwAeLSWqNgko00rkTGUAs3rAoqESS_z9oJILI5yID1CCYSb-gdvL-46F9c7oGYkn7qb7eh_OCyNEMMl9yvDPIR2ZdZCIFQjEVIaGN3_BHeRQNLaZEtAY76VEo31wKxyVx3OaiHAEoYXmTQzizppQ_wcOqafdJ7D1eXG-GeqQmLw
tenant: f743b7ef-42df-4d7e-89dd-90dc3b53b0ac
Content-Length: 891
Host: www.predixapis.com
{
"entityTypeSubscriptions" : {
"ALERT" : [ {
"complexWatchable" : {
"entityType" : "ALERT",
"trigger" : "ALERT_CREATED",
"fieldExpressions" : {
"wizardFilters" : [ ],
"filters" : [ {
"operation" : "eq",
"operand2" : [ "2" ],
"operand1" : {
"displayName" : "Severity",
"path" : "alarm.severity",
"type" : "NUMBER",
"entity" : "ALARM",
"tenantId" : null,
"possibleOperations" : null,
"builderClass" : "com.ge.apm.filtering.impl.NumberFilterQueryBuilder",
"operationTranslations" : null,
"operand2Translations" : null
}
} ]
},
"actionTypeId" : 2,
"actionValue" : {
"name" : "LATCH_ALERT"
}
}
} ]
}
}
Request structure
Path | Type | Description |
---|---|---|
|
|
Subscriptions |
|
|
Value is ALERT or CASES depending on where latched alert needs to be created |
|
|
Collection of fields and filters required to create latched alert |
|
|
Value can be ALERT or CASES depending on the rule where latched alert needs to be created |
|
|
Either ALERT_CREATED or ALERT_DISPOSITION_UPDATED depending on the condition |
|
|
Set of filters that can be applied→ Severity, Source, Alert Type, Alert Name |
|
|
Id of action type |
|
|
Action to be taken upon creation |
*Required fields
Example response
HTTP/1.1 200 OK