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

GET

Used to retrieve a resource

POST

Used to create a new resource

PATCH

Used to update an existing resource, including partial updates

DELETE

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

200 OK

The request completed successfully

202 Accepted

A new resource has been created successfully. The resource’s URI is available from the response’s Location header

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

404 Not Found

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/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,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}'

Example HTTP request

POST /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: 1530
Host: www.predixapis.com

{
  "severity" : 3,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}

Request structure

Path Type Description

name

String

*This should match the name of the Alarm Profile that already exists in APM

associatedMonitoredEntityUuid

String

*Asset UUID, which is already ingested in APM Asset

eventStart

Number

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!

storageReceiveTime

Number

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!

severity

Number

By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten.

scanGroupData

Object

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

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

tagsOfInterest

Array

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

tenantUuId

String

Tenant under which this alarm will be created and is accessible

isTrip

Boolean

isTrip

analyticInstanceId

String

analyticInstanceId

trip

Boolean

trip

isActive

Boolean

isActive

isArchived

Boolean

Optional parameter, default null returns all active and archived alerts. isArchived true returns only archived alerts , false returns only active alerts

recurring

Boolean

if the alarm is a recurring alarm

limitedVisibility

Boolean

if the alarm has limited visibility

latchCount

Number

Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored

disablePrefetch

Boolean

disablePrefetch flag

staleAlertDays

Number

This days calculated between Event Time and Alert Creation time

isAutoDisposition

Boolean

This flag used to identify whether alert is Auto Disposition or Not

*Required fields

Example response

HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 151

{
  "uuid" : "790630814F5A4117A6A5E8E31CD56338",
  "links" : [ {
    "rel" : "self",
    "href" : "/v1/alarms/790630814F5A4117A6A5E8E31CD56338"
  } ]
}

Getting an Alarm by UUID

A GET request is used to get alarm details.

Example CURL request

$ curl 'https://www.predixapis.com/v1/alarms/790630814F5A4117A6A5E8E31CD56338' -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 /v1/alarms/790630814F5A4117A6A5E8E31CD56338 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: 5378

{
  "severity" : 3,
  "isTrip" : 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" : "790630814F5A4117A6A5E8E31CD56338",
  "isActive" : true,
  "createdOn" : 1773205636029,
  "updatedOn" : 1773205636509,
  "sourceKey" : "59a25bd7-d77b-47fa-8bdc-365fd44b78b4",
  "createdBy" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "id" : 79,
  "alarmState" : {
    "id" : 235,
    "uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205031758,
    "updatedOn" : 1773205031758,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "Ready",
    "description" : "Ready"
  },
  "alarmDisposition" : {
    "id" : 284,
    "uuid" : "5f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205031758,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "None",
    "description" : "None"
  },
  "alarmAsset" : {
    "id" : 1,
    "uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
    "isActive" : true,
    "createdOn" : 1773204961513,
    "updatedOn" : 1773204961513,
    "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",
  "isArchived" : false,
  "latchCount" : 1,
  "lastOccurrence" : 1439999220000,
  "previousSeverity" : 3,
  "firstOccurrence" : 1439320020000,
  "lastProcessedTime" : 1439320020000,
  "lastObservationTime" : 1439320020000,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : false,
  "trip" : false,
  "noOfInternalNotes" : 0,
  "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"
  } ],
  "noOfNotes" : 0,
  "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" : {
      "uuid" : "93E04CA186EE4BA496C1DBB304953067",
      "isActive" : true,
      "id" : 12,
      "name" : "SmartSignal",
      "description" : "SmartSignal",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
      "processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor"
    },
    "type" : {
      "uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
      "isActive" : true,
      "id" : 8,
      "name" : "Generic",
      "description" : "Generic",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6"
    },
    "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

[]

Array

A list of patch operations to perform

[].op

String

*Type of patch operation, possible values are: ADD, REPLACE and REMOVE

[].path

String

*This is the alarm field to patch. In this case, alarmDisposition.name

[].value

String

*The new value of the field

*Required fields

Example CURL request 1

$ curl 'https://www.predixapis.com/v1/alarms/790630814F5A4117A6A5E8E31CD56338' -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 /v1/alarms/790630814F5A4117A6A5E8E31CD56338 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: 205

{
  "path" : "",
  "requestId" : "23f5f843-6922-4d22-a9a8-b803e176fdf2",
  "errorId" : "PATCH_UNAUTHORIZED",
  "errorMessage" : "Unauthorized access patch call.:",
  "timestamp" : "2026-03-11T05:07+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 /v1/alarms/790630814F5A4117A6A5E8E31CD56338 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 /v1/alarms/790630814F5A4117A6A5E8E31CD56338 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/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 /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

String

Name of the filter

userId

String

User ID of the filter

defaultFilterSet

Boolean

If this filter is the default filter set, either true or false

filters

Array

List of filter(s)

filters[].operation

String

Type of filter operation. Possible values are: contains

filters[].operand2

Varies

Operand2 can be a filter text or dropdpwn values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" ,

filters[].operand1

Object

Operand1

filters[].operand1.builderClass

String

Class that builds the operand

filters[].operand1.displayName

String

Name of the operand

filters[].operand1.entity

String

Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE

filters[].operand1.path

String

Path of the operand

filters[].operand1.type

String

Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE

filters[].operand1.operationTranslations

Object

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/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 /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

fields

Comma separated List of Alarm Entity attributes are its descendent’s attributes

aggregatedFields

Comma separated List of Aggregated Alarm Entity numeric attributes

sortField

Field selected for orderBy eg: id-count

sortOrder

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/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 /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: 1386

{
  "disposition" : [ {
    "id" : 278,
    "name" : "Valid",
    "uuid" : "21decd7f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 279,
    "name" : "False",
    "uuid" : "21ded33f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 280,
    "name" : "False System",
    "uuid" : "21ded4da-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 281,
    "name" : "Sensor Issue",
    "uuid" : "21ded5ed-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 282,
    "name" : "Reset State Dat",
    "uuid" : "36d7728f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 283,
    "name" : "Outage",
    "uuid" : "4f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 284,
    "name" : "None",
    "uuid" : "5f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1469,
    "name" : "Alarm-Disposition-Name",
    "uuid" : "uuid",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 1
  } ]
}

Response structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].name

String

name of tenant configuration

disposition[].uuid

String

Unique ID of tenant configuration

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

disposition[].isDeleted

Boolean

true if tenant configuration deleted, false otherwise

disposition[].displayOrder

Number

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/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,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 225
Host: www.predixapis.com

{
  "disposition" : [ {
    "name" : "Alarm-Disposition-Name",
    "description" : "alarm-description",
    "isActive" : true,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].displayOrder

Number

displayorder of tenant configuration

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].name

String

name of tenant configuration

disposition[].description

String

description of disposition

disposition[].uuid

String

Unique ID of disposition

disposition[].locale

String

Language of disposition

disposition[].isActive

Boolean

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/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" : 1469,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 204
Host: www.predixapis.com

{
  "disposition" : [ {
    "id" : 1469,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].description

String

Description of the disposition

disposition[].uuid

String

uuid of the disposition

disposition[].locale

String

language of name

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].displayOrder

Number

display order for tenant configuration

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

*Required fields

Example response

HTTP/1.1 500 Internal Server Error
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186

{
  "path" : "",
  "requestId" : "9bd0f356-5609-406a-b233-f3e556f25367",
  "errorId" : "SERVICE_FAILURE",
  "errorMessage" : "Contact support.",
  "timestamp" : "2026-03-11T05:07+0000"
}

Getting Custom Attributes

A GET request is used get custom attributes.

Example CURL request

$ curl 'https://www.predixapis.com/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 /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" : 4,
  "attributeName" : "testAttribute",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
} ]

Response structure

Path Type Description

[].id

Number

id of custom attribute

[].attributeName

String

variable name of custom attribute

[].displayName

String

display name of custom attribute

[].attributeType

String

the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

[].visibility

Boolean

visibility of custom attribute on front end

[].minValue

Number

min value of NUMBER type custom attribute

[].maxValue

Number

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/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 '{
  "attributeName" : "testAttribute",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}'

Example HTTP request

POST /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: 170
Host: www.predixapis.com

{
  "attributeName" : "testAttribute",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}

Request structure

Path Type Description

attributeName

String

*The name that will represent the custom attribute value. Cannot already exist in the tenant.

displayName

String

*The display name of the custom attribute, which will be shown on the front-end.

attributeType

String

*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

visibility

Boolean

*Boolean whether the custom attribute will be displayed on the front-end.

minValue

Number

*The minimum value the custom attribute can be (only applies to type NUMBER).

maxValue

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 APIs

Creating a SmartSignal Alarm

A POST request is used to create alarm.

Example CURL request

$ curl 'https://www.predixapis.com/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,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}'

Example HTTP request

POST /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: 1530
Host: www.predixapis.com

{
  "severity" : 3,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}

Request structure

Path Type Description

name

String

*This should match the name of the Alarm Profile that already exists in APM

associatedMonitoredEntityUuid

String

*Asset UUID, which is already ingested in APM Asset

eventStart

Number

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!

storageReceiveTime

Number

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!

severity

Number

By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten.

scanGroupData

Object

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

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

tagsOfInterest

Array

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

tenantUuId

String

Tenant under which this alarm will be created and is accessible

isTrip

Boolean

isTrip

analyticInstanceId

String

analyticInstanceId

trip

Boolean

trip

isActive

Boolean

isActive

isArchived

Boolean

Optional parameter,when not passed by default returns all active and archived alerts. isArchived true returns only archived alerts , false returns only active alerts

recurring

Boolean

if the alarm is a recurring alarm

limitedVisibility

Boolean

if the alarm has limited visibility

latchCount

Number

Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored

disablePrefetch

Boolean

disablePrefetch flag

staleAlertDays

Number

This days calculated between Event Time and Alert Creation time

isAutoDisposition

Boolean

This flag used to identify whether alert is Auto Disposition or Not

*Required fields

Example response

HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 196

{
  "uuid" : "03D26224ED604090ABC556A11345B047",
  "links" : [ {
    "rel" : "self",
    "href" : "/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/03D26224ED604090ABC556A11345B047"
  } ]
}

Getting an Alarm by UUID

A GET request is used to get alarm details.

Example CURL request

$ curl 'https://www.predixapis.com/v3/alarms/03D26224ED604090ABC556A11345B047' -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 /v3/alarms/03D26224ED604090ABC556A11345B047 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: 5412

{
  "severity" : 3,
  "isTrip" : 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" : "03D26224ED604090ABC556A11345B047",
  "isActive" : true,
  "createdOn" : 1773205650749,
  "updatedOn" : 1773205650838,
  "sourceKey" : "858ffc9c-5b3b-4ade-91ba-5bdd64c8b93f",
  "createdBy" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "id" : 80,
  "alarmState" : {
    "id" : 235,
    "uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205031758,
    "updatedOn" : 1773205031758,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "Ready",
    "description" : "Ready"
  },
  "alarmDisposition" : {
    "id" : 1472,
    "uuid" : "5f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205650597,
    "updatedOn" : 1773205650597,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "None",
    "description" : "None"
  },
  "alarmAsset" : {
    "id" : 1,
    "uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
    "isActive" : true,
    "createdOn" : 1773204961513,
    "updatedOn" : 1773204961513,
    "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",
  "isArchived" : false,
  "latchCount" : 1,
  "lastOccurrence" : 1439999220000,
  "previousSeverity" : 3,
  "firstOccurrence" : 1439320020000,
  "lastProcessedTime" : 1439320020000,
  "lastObservationTime" : 1439320020000,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : false,
  "trip" : false,
  "noOfInternalNotes" : 0,
  "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"
  },
  "noOfNotes" : 0,
  "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" : {
      "uuid" : "93E04CA186EE4BA496C1DBB304953067",
      "isActive" : true,
      "id" : 12,
      "name" : "SmartSignal",
      "description" : "SmartSignal",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
      "processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor"
    },
    "type" : {
      "uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
      "isActive" : true,
      "id" : 8,
      "name" : "Generic",
      "description" : "Generic",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6"
    },
    "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

[]

Array

A list of patch operations to perform

[].op

String

*Type of patch operation, possible values are: ADD, REPLACE and REMOVE

[].path

String

*This is the alarm field to patch. In this case, alarmDisposition.name

[].value

String

*The new value of the field

*Required fields

Example CURL request 1

$ curl 'https://www.predixapis.com/v3/alarms/03D26224ED604090ABC556A11345B047' -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 /v3/alarms/03D26224ED604090ABC556A11345B047 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: 205

{
  "path" : "",
  "requestId" : "8962849c-4e24-4676-9ab4-2cf6fd057fe8",
  "errorId" : "PATCH_UNAUTHORIZED",
  "errorMessage" : "Unauthorized access patch call.:",
  "timestamp" : "2026-03-11T05:07+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 /v3/alarms/03D26224ED604090ABC556A11345B047 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 /v3/alarms/03D26224ED604090ABC556A11345B047 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/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 /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

String

Name of the filter

userId

String

User ID of the filter

defaultFilterSet

Boolean

If this filter is the default filter set, either true or false

filters

Array

List of filter(s)

filters[].operation

String

Type of filter operation. Possible values are: contains

filters[].operand2

Varies

Operand2 can be a filter text or dropdown values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" ,

filters[].operand1

Object

Operand1

filters[].operand1.builderClass

String

Class that builds the operand

filters[].operand1.displayName

String

Name of the operand

filters[].operand1.entity

String

Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE

filters[].operand1.path

String

Path of the operand

filters[].operand1.type

String

Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE

filters[].operand1.operationTranslations

Object

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/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 /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

fields

Comma separated List of Alarm Entity attributes are its descendent’s attributes

aggregatedFields

Comma separated List of Aggregated Alarm Entity numeric attributes

sortField

Field selected for orderBy eg: id-count

sortOrder

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/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 /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

String

Name of the filter

userId

String

User ID of the filter

defaultFilterSet

Boolean

If this filter is the default filter set, either true or false

filters

Array

List of filter(s)

filters[].operation

String

Type of filter operation. Possible values are: contains

filters[].operand2

Varies

Operand2

filters[].operand1

Object

Operand1

filters[].operand1.builderClass

String

Class that builds the operand

filters[].operand1.displayName

String

Name of the operand

filters[].operand1.entity

String

Entity of the operand. Possible values are: USER

filters[].operand1.path

String

Path of the operand

filters[].operand1.type

String

Type of the operand. Possible values are: TEXT

filters[].operand1.operationTranslations

Object

Operation Translations

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 471

{
  "content" : [ ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 1,
    "sort" : {
      "sorted" : false,
      "empty" : true,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 0,
  "totalPages" : 0,
  "first" : true,
  "size" : 1,
  "number" : 0,
  "sort" : {
    "sorted" : false,
    "empty" : true,
    "unsorted" : true
  },
  "numberOfElements" : 0,
  "empty" : true
}

Delete Alerts by UUID/Id

A DELETE request is used to delete alarms.

Example CURL request

$ curl 'https://www.predixapis.com/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" : [ "80", "42" ]
}'

Example HTTP request

DELETE /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" : [ "80", "42" ]
}

OR

DELETE /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" : [ "03D26224ED604090ABC556A11345B047", "42133F8C09B1486E85CADBDB24626EFA" ]
}

Request Structure

Path Type Description

ids

Array

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: 102

{
  "InvalidIds" : [ ],
  "AccessDeniedIds" : [ ],
  "message" : "Successfully deleted valid alerts"
}

OR

HTTP/1.1 404 Not Found
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 219

{
  "path" : "",
  "requestId" : "3146620a-15a4-4e3b-9cfa-8b5cf5ee007c",
  "errorId" : "ALARMS_NOT_FOUND",
  "errorMessage" : "Alarms not found:Could not find alarms to delete",
  "timestamp" : "2026-03-11T05:07+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/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 /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

[].alarmId

Null

Id of the alert. This is an optional field.

[].uuid

String

UUID of alert.

[].incident

Object

Incident object of the alert in json format.

[].incident.incidentEventCount

Number

Event count of the alert.

[].incident.density

String

Density of the incoming alert. Its a floating point value.

[].incident.lastProcessedTime

String

Last processed time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format.

[].incident.lastObservationTime

String

Last observation time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format.

[].incident.firstOccurance

String

First occurrence time of the alert in YYYY-MM-DD’T’hh:mm:ss.SSS’Z' format.

[].incident.lastOccurance

String

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/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" : 1773205652066,
  "endTime" : 1773220052066,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}'

Example HTTP request

POST /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: 233
Host: www.predixapis.com

{
  "startTime" : 1773205652066,
  "endTime" : 1773220052066,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}

Request Structure

Path Type Description

assetAssociatedUuid

String

true if its Internal Note, false otherwise

alertName

String

Name of the alert

startTime

Number

Start time

endTime

Number

End time

frequency

Number

Frequency of recurrence

assetSourceId

String

Asset source ID

*Required fields

Example response

HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 276

{
  "createdon" : 1773205652251,
  "startTime" : 1773205652066,
  "endTime" : 1773220052066,
  "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/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 /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" : 1773205652251,
  "startTime" : 1773205652066,
  "endTime" : 1773220052066,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "id" : 3,
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
  "createdon" : 1773205032216,
  "startTime" : 1773205032189,
  "endTime" : 1773219432189,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "id" : 2,
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
  "createdon" : 1773204997228,
  "startTime" : 1773204997151,
  "endTime" : 1773219397151,
  "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/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 /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: 223

{
  "path" : "",
  "requestId" : "77ae3c89-12e1-4b39-b406-f43b7192cdef",
  "errorId" : "ALARM_NOT_FOUND",
  "errorMessage" : "Alarm not found:no recurring alarm found with uuid 10",
  "timestamp" : "2026-03-11T05:07+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/v3/alarms/audit/03D26224ED604090ABC556A11345B047' -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 /v3/alarms/audit/03D26224ED604090ABC556A11345B047 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: 1847

[ {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "03D26224ED604090ABC556A11345B047",
  "alertName" : "TEST_SS_PROFILE",
  "assetId" : "test1234",
  "assetName" : "test1234",
  "description" : "Marked as In Process Maintenance",
  "customProperties" : "{}",
  "classifier" : "SUCCESS",
  "actionType" : "Marked as In Process Maintenance",
  "actionTimestamp" : 1773205651676,
  "alertCreationTimestamp" : 1439320020000,
  "uploaded" : false
}, {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "03D26224ED604090ABC556A11345B047",
  "alertName" : "TEST_SS_PROFILE",
  "assetId" : "test1234",
  "assetName" : "test1234",
  "description" : "Claimed Alert",
  "customProperties" : "{}",
  "classifier" : "SUCCESS",
  "actionType" : "Claimed Alert",
  "actionTimestamp" : 1773205651435,
  "alertCreationTimestamp" : 1439320020000,
  "uploaded" : false
}, {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "03D26224ED604090ABC556A11345B047",
  "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" : 1773205650876,
  "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/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 '{
  "text" : "Notes 123",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false,
  "parentEntityType" : "Alarm"
}'

Example HTTP request

POST /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: 193
Host: www.predixapis.com

{
  "text" : "Notes 123",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false,
  "parentEntityType" : "Alarm"
}

Request Structure

Path Type Description

isPrivateNote

Boolean

true if its Internal Note, false otherwise

parentEntityType

String

Type of parent alarm

parentEntityUuid

String

UUID of parent alarm

text

String

Description of notes

isArchived

Boolean

Optional parameter, default null returns all active and archived alerts. isArchived true returns only archived alerts , false returns only active alerts

isDeletable

Boolean

NA

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 811

{
  "id" : 48,
  "uuid" : "885BB0935FDE4C8E9BFB9D5DFB013871",
  "text" : "Notes 123",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205652625,
  "updatedOn" : 1773205652625,
  "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/v3/alarms/notes?parentEntityUuid=03D26224ED604090ABC556A11345B047&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 /v3/alarms/notes?parentEntityUuid=03D26224ED604090ABC556A11345B047&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: 877

{
  "data" : [ {
    "id" : 48,
    "uuid" : "885BB0935FDE4C8E9BFB9D5DFB013871",
    "text" : "Notes 123",
    "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "isArchived" : false,
    "userOwner" : {
      "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
      "name" : "rcsampleg-smokeuser",
      "userFullName" : "rcsampleg-smokeuser GE",
      "firstName" : "rcsampleg-smokeuser",
      "lastName" : "GE",
      "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
      "id" : 2,
      "isActive" : true,
      "createdOn" : 1773204962375,
      "updatedOn" : 1773204962375
    },
    "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "isPrivateNote" : false,
    "createdOn" : 1773205652625,
    "updatedOn" : 1773205652625,
    "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/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 '[ {
  "text" : "first note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "second  note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "third note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
} ]'

Example HTTP request

POST /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: 496
Host: www.predixapis.com

[ {
  "text" : "first note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "second  note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "third note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
} ]

Request Structure

Path Type Description

[]

Array

true if its Internal Note, false otherwise

[].isPrivateNote

Boolean

true if its Internal Note, false otherwise

[].parentEntityUuid

String

ID of parent alarm

[].text

String

Description of notes

[].isArchived

Boolean

can add notes only for active alerts

[].isDeletable

Boolean

NA

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 2350

[ {
  "id" : 49,
  "uuid" : "A52A36EA6E7F42D1A4331E06C9739373",
  "text" : "first note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205652816,
  "updatedOn" : 1773205652816,
  "isDeletable" : true
}, {
  "id" : 50,
  "uuid" : "232BBE35154B4E0C817AB51615F10909",
  "text" : "second  note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205652818,
  "updatedOn" : 1773205652818,
  "isDeletable" : true
}, {
  "id" : 51,
  "uuid" : "74713124007941AFBC1591FC3AA1C298",
  "text" : "third note",
  "parentEntityUuid" : "03D26224ED604090ABC556A11345B047",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205652829,
  "updatedOn" : 1773205652829,
  "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/v3/alarms/attachments?parentEntityUuid=03D26224ED604090ABC556A11345B047&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'

Example HTTP request

POST /v3/alarms/attachments?parentEntityUuid=03D26224ED604090ABC556A11345B047&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=file; filename=blog.txt
Content-Type: text/plain

text
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Structure

Part Description

file

The file to upload

*Required fields

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/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 /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/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 /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

entityTypeSubscriptions

Object

Subscriptions

entityTypeSubscriptions.ALERT[]

Array

Value is ALERT or CASES depending on where latched alert needs to be created

entityTypeSubscriptions.ALERT[].complexWatchable

Object

Collection of fields and filters required to create latched alert

entityTypeSubscriptions.ALERT[].complexWatchable.entityType

String

Value can be ALERT or CASES depending on the rule where latched alert needs to be created

entityTypeSubscriptions.ALERT[].complexWatchable.trigger

String

Either ALERT_CREATED or ALERT_DISPOSITION_UPDATED depending on the condition

entityTypeSubscriptions.ALERT[].complexWatchable.fieldExpressions.filters

Array

Set of filters that can be applied→ Severity, Source, Alert Type, Alert Name

entityTypeSubscriptions.ALERT[].complexWatchable.actionTypeId

Number

Id of action type

entityTypeSubscriptions.ALERT[].complexWatchable.actionValue

Object

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/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 /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: 179

{
  "disposition" : [ {
    "id" : 1470,
    "name" : "Alarm-Disposition-Name",
    "uuid" : "uuid",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 1
  } ]
}

Response structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].name

String

name of tenant configuration

disposition[].uuid

String

Unique ID of tenant configuration

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

disposition[].isDeleted

Boolean

true if tenant configuration deleted, false otherwise

disposition[].displayOrder

Number

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/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,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 225
Host: www.predixapis.com

{
  "disposition" : [ {
    "name" : "Alarm-Disposition-Name",
    "description" : "alarm-description",
    "isActive" : true,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].displayOrder

Number

displayorder of tenant configuration

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].name

String

name of tenant configuration

disposition[].description

String

description of disposition

disposition[].uuid

String

Unique ID of disposition

disposition[].locale

String

Language of disposition

disposition[].isActive

Boolean

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/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" : 1470,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 204
Host: www.predixapis.com

{
  "disposition" : [ {
    "id" : 1470,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].description

String

Description of the disposition

disposition[].uuid

String

uuid of the disposition

disposition[].locale

String

language of name

disposition[].displayOrder

Number

display order for tenant configuration

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

*Required fields

Example response

HTTP/1.1 500 Internal Server Error
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186

{
  "path" : "",
  "requestId" : "34fcd588-e074-4578-bf2e-29fea7fb8064",
  "errorId" : "SERVICE_FAILURE",
  "errorMessage" : "Contact support.",
  "timestamp" : "2026-03-11T05:07+0000"
}

Getting Custom Attributes

A GET request is used get custom attributes.

Example CURL request

$ curl 'https://www.predixapis.com/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 /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: 188

[ {
  "id" : 5,
  "attributeName" : "testAttributeV3",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
} ]

Response structure

Path Type Description

[].id

Number

id of custom attribute

[].attributeName

String

variable name of custom attribute

[].displayName

String

display name of custom attribute

[].attributeType

String

the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

[].visibility

Boolean

visibility of custom attribute on front end

[].minValue

Number

min value of NUMBER type custom attribute

[].maxValue

Number

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/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 '{
  "attributeName" : "testAttributeV3",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}'

Example HTTP request

POST /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: 172
Host: www.predixapis.com

{
  "attributeName" : "testAttributeV3",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}

Request structure

Path Type Description

attributeName

String

*The name that will represent the custom attribute value. Cannot already exist in the tenant.

displayName

String

*The display name of the custom attribute, which will be shown on the front-end.

attributeType

String

*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

visibility

Boolean

*Boolean whether the custom attribute will be displayed on the front-end.

minValue

Number

*The minimum value the custom attribute can be (only applies to type NUMBER).

maxValue

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: 184

{
  "id" : 5,
  "attributeName" : "testAttributeV3",
  "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/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,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}'

Example HTTP request

POST /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: 1530
Host: www.predixapis.com

{
  "severity" : 3,
  "isTrip" : false,
  "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,
  "isArchived" : false,
  "latchCount" : 1,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : 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"
  }
}

Request structure

Path Type Description

name

String

*This should match the name of the Alarm Profile that already exists in APM

associatedMonitoredEntityUuid

String

*Asset UUID, which is already ingested in APM Asset

eventStart

Number

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!

storageReceiveTime

Number

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!

severity

Number

By default the severity os picked up from the Alarm Profile. Any value provided here will be overwritten.

scanGroupData

Object

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

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

tagsOfInterest

Array

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

tenantUuId

String

Tenant under which this alarm will be created and is accessible

isTrip

Boolean

Indicates if the alarm is a trip alarm

trip

Boolean

Trip indicator

analyticInstanceId

String

Analytic instance identifier

isActive

Boolean

isActive

isArchived

Boolean

Optional parameter, default null returns all active and archived alerts. isArchived true returns only archived alerts , false returns only active alerts

recurring

Boolean

if the alarm is a recurring alarm

limitedVisibility

Boolean

if the alarm has limited visibility

latchCount

Number

Reserved attribute. Do not use as a custom attribute. A value if provided will be ignored

disablePrefetch

Boolean

disablePrefetch flag

staleAlertDays

Number

This days calculated between Event Time and Alert Creation time

isAutoDisposition

Boolean

This flag used to identify whether alert is Auto Disposition or Not

*Required fields

Example response

HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 196

{
  "uuid" : "80862411135A47AA9F0B2689B86B873B",
  "links" : [ {
    "rel" : "self",
    "href" : "/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B"
  } ]
}

Getting an Alarm by UUID

A GET request is used to get alarm details.

Example CURL request

$ curl 'https://www.predixapis.com/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B' -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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B 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: 5380

{
  "severity" : 3,
  "isTrip" : 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" : "80862411135A47AA9F0B2689B86B873B",
  "isActive" : true,
  "createdOn" : 1773205659169,
  "updatedOn" : 1773205659203,
  "sourceKey" : "19c2160d-6124-40ee-8904-aea79935b8c9",
  "createdBy" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "id" : 81,
  "alarmState" : {
    "id" : 1328,
    "uuid" : "0b7c6bbb-c11a-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205659063,
    "updatedOn" : 1773205659063,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "Ready",
    "description" : "Ready"
  },
  "alarmDisposition" : {
    "id" : 1571,
    "uuid" : "5f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "createdOn" : 1773205659063,
    "locale" : "en-US",
    "tenantUuId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "name" : "None",
    "description" : "None"
  },
  "alarmAsset" : {
    "id" : 1,
    "uuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
    "isActive" : true,
    "createdOn" : 1773204961513,
    "updatedOn" : 1773204961513,
    "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",
  "isArchived" : false,
  "latchCount" : 1,
  "lastOccurrence" : 1439999220000,
  "previousSeverity" : 3,
  "firstOccurrence" : 1439320020000,
  "lastProcessedTime" : 1439320020000,
  "lastObservationTime" : 1439320020000,
  "analyticInstanceId" : "00000000-0000-0000-0000-000000000000",
  "disablePrefetch" : false,
  "staleAlertDays" : 0,
  "isAutoDisposition" : false,
  "trip" : false,
  "noOfInternalNotes" : 0,
  "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"
  } ],
  "noOfNotes" : 0,
  "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" : {
      "uuid" : "93E04CA186EE4BA496C1DBB304953067",
      "isActive" : true,
      "id" : 12,
      "name" : "SmartSignal",
      "description" : "SmartSignal",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6",
      "processorClass" : "com.ge.apm.alarmmanagement.service.impl.SsAlarmProcessor"
    },
    "type" : {
      "uuid" : "56ED77FEB3804AEB93226FE8AC1FCEE2",
      "isActive" : true,
      "id" : 8,
      "name" : "Generic",
      "description" : "Generic",
      "tenantUuid" : "7F2731AA16B24053A9D3056B4A8FFCC6"
    },
    "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

[]

Array

A list of patch operations to perform

[].op

String

*Type of patch operation, possible values are: ADD, REPLACE and REMOVE

[].path

String

*This is the alarm field to patch. In this case, alarmDisposition.name

[].value

String

*The new value of the field

*Required fields

Example CURL request 1

$ curl 'https://www.predixapis.com/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B' -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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B 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: 205

{
  "path" : "",
  "requestId" : "f7d40345-998c-4869-8da3-055b9e15e627",
  "errorId" : "PATCH_UNAUTHORIZED",
  "errorMessage" : "Unauthorized access patch call.:",
  "timestamp" : "2026-03-11T05:07+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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B 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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/80862411135A47AA9F0B2689B86B873B 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/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 /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

String

Name of the filter

userId

String

User ID of the filter

defaultFilterSet

Boolean

If this filter is the default filter set, either true or false

filters

Array

List of filter(s)

filters[].operation

String

Type of filter operation. Possible values are: contains

filters[].operand2

Varies

Operand2 can be a filter text or dropdown values available for the particular operation(array of values). Example: "operand2": [ "Ready", "In Process", "Processed" ,

filters[].operand1

Object

Operand1

filters[].operand1.builderClass

String

Class that builds the operand

filters[].operand1.displayName

String

Name of the operand

filters[].operand1.entity

String

Entity of the operand. Possible values are: ALARM, USER, PROFILE, NOTE

filters[].operand1.path

String

Path of the operand

filters[].operand1.type

String

Type of the operand. Possible values are: STRING, BOOLEAN, TEXT, DATE

filters[].operand1.operationTranslations

Object

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/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 /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

fields

Comma separated List of Alarm Entity attributes are its descendent’s attributes

aggregatedFields

Comma separated List of Aggregated Alarm Entity numeric attributes

sortField

Field selected for orderBy eg: id-count

sortOrder

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/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 /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: 1393

{
  "disposition" : [ {
    "id" : 1473,
    "name" : "Valid",
    "uuid" : "21decd7f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1474,
    "name" : "False",
    "uuid" : "21ded33f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1475,
    "name" : "False System",
    "uuid" : "21ded4da-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1476,
    "name" : "Sensor Issue",
    "uuid" : "21ded5ed-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1477,
    "name" : "Reset State Dat",
    "uuid" : "36d7728f-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1478,
    "name" : "Outage",
    "uuid" : "4f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1479,
    "name" : "None",
    "uuid" : "5f0b6582-c119-11e4-bcef-a0481cabcba7",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 0
  }, {
    "id" : 1564,
    "name" : "Alarm-Disposition-Name",
    "uuid" : "uuid",
    "isActive" : true,
    "isDeleted" : false,
    "displayOrder" : 1
  } ]
}

Response structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].name

String

name of tenant configuration

disposition[].uuid

String

Unique ID of tenant configuration

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

disposition[].isDeleted

Boolean

true if tenant configuration deleted, false otherwise

disposition[].displayOrder

Number

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/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 /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

String

Name of the filter

userId

String

User ID of the filter

defaultFilterSet

Boolean

If this filter is the default filter set, either true or false

filters

Array

List of filter(s)

filters[].operation

String

Type of filter operation. Possible values are: contains

filters[].operand2

Varies

Operand2

filters[].operand1

Object

Operand1

filters[].operand1.builderClass

String

Class that builds the operand

filters[].operand1.displayName

String

Name of the operand

filters[].operand1.entity

String

Entity of the operand. Possible values are: USER

filters[].operand1.path

String

Path of the operand

filters[].operand1.type

String

Type of the operand. Possible values are: TEXT

filters[].operand1.operationTranslations

Object

Operation Translations

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 471

{
  "content" : [ ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 1,
    "sort" : {
      "sorted" : false,
      "empty" : true,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 0,
  "totalPages" : 0,
  "first" : true,
  "size" : 1,
  "number" : 0,
  "sort" : {
    "sorted" : false,
    "empty" : true,
    "unsorted" : true
  },
  "numberOfElements" : 0,
  "empty" : true
}

Delete Alerts by UUID/Id

A DELETE request is used to delete alarms.

Example CURL request

$ curl 'https://www.predixapis.com/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" : [ "81", "42" ]
}'

Example HTTP request

DELETE /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" : [ "81", "42" ]
}

OR

DELETE /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" : [ "80862411135A47AA9F0B2689B86B873B", "42133F8C09B1486E85CADBDB24626EFA" ]
}

Request Structure

Path Type Description

ids

Array

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: 219

{
  "path" : "",
  "requestId" : "20adf559-00bf-4624-afa8-0053f915320d",
  "errorId" : "ALARMS_NOT_FOUND",
  "errorMessage" : "Alarms not found:Could not find alarms to delete",
  "timestamp" : "2026-03-11T05:07+0000"
}

Create Recurring Alarm

A POST request is used to create recurring alarms.

Example CURL request

$ curl 'https://www.predixapis.com/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" : 1773205659568,
  "endTime" : 1773220059568,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}'

Example HTTP request

POST /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: 233
Host: www.predixapis.com

{
  "startTime" : 1773205659568,
  "endTime" : 1773220059568,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}

Request Structure

Path Type Description

assetAssociatedUuid

String

true if its Internal Note, false otherwise

alertName

String

Name of the alert

startTime

Number

Start time

endTime

Number

End time

frequency

Number

Frequency of recurrence

assetSourceId

String

Asset source ID

*Required fields

Example response

HTTP/1.1 201 Created
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 276

{
  "createdon" : 1773205659603,
  "startTime" : 1773205659568,
  "endTime" : 1773220059568,
  "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/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 /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" : 1773205659603,
  "startTime" : 1773205659568,
  "endTime" : 1773220059568,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "id" : 4,
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
  "createdon" : 1773205652251,
  "startTime" : 1773205652066,
  "endTime" : 1773220052066,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "id" : 3,
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
  "createdon" : 1773205032216,
  "startTime" : 1773205032189,
  "endTime" : 1773219432189,
  "frequency" : 2,
  "alertName" : "KM-Test-Alert",
  "assetAssociatedUuid" : "/assets/f7c2cbe8-f96b-3f0d-8e54-360d55dc2e7b",
  "id" : 2,
  "assetSourceId" : "Inverter1-ASSET-TYPE1"
}, {
  "createdon" : 1773204997228,
  "startTime" : 1773204997151,
  "endTime" : 1773219397151,
  "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/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 /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: 223

{
  "path" : "",
  "requestId" : "5def8a11-3f06-4dd3-acad-338b80975654",
  "errorId" : "ALARM_NOT_FOUND",
  "errorMessage" : "Alarm not found:no recurring alarm found with uuid 10",
  "timestamp" : "2026-03-11T05:07+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/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/audit/80862411135A47AA9F0B2689B86B873B' -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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/audit/80862411135A47AA9F0B2689B86B873B 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: 1847

[ {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "80862411135A47AA9F0B2689B86B873B",
  "alertName" : "TEST_SS_PROFILE",
  "assetId" : "test1234",
  "assetName" : "test1234",
  "description" : "Marked as In Process Maintenance",
  "customProperties" : "{}",
  "classifier" : "SUCCESS",
  "actionType" : "Marked as In Process Maintenance",
  "actionTimestamp" : 1773205659471,
  "alertCreationTimestamp" : 1439320020000,
  "uploaded" : false
}, {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "80862411135A47AA9F0B2689B86B873B",
  "alertName" : "TEST_SS_PROFILE",
  "assetId" : "test1234",
  "assetName" : "test1234",
  "description" : "Claimed Alert",
  "customProperties" : "{}",
  "classifier" : "SUCCESS",
  "actionType" : "Claimed Alert",
  "actionTimestamp" : 1773205659412,
  "alertCreationTimestamp" : 1439320020000,
  "uploaded" : false
}, {
  "actorUUID" : "not available",
  "actorName" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac_ingestor",
  "actorDisplayName" : "rcsampleg-smokeuser GE",
  "tenantUUID" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "alertUUID" : "80862411135A47AA9F0B2689B86B873B",
  "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" : 1773205659216,
  "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/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 '{
  "text" : "Notes 123",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false,
  "parentEntityType" : "Alarm"
}'

Example HTTP request

POST /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: 193
Host: www.predixapis.com

{
  "text" : "Notes 123",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false,
  "parentEntityType" : "Alarm"
}

Request Structure

Path Type Description

isPrivateNote

Boolean

true if its Internal Note, false otherwise

parentEntityType

String

Type

parentEntityUuid

String

ID of parent alarm

isArchived

Boolean

Optional parameter, default null returns all active and archived alerts. isArchived true returns only archived alerts , false returns only active alerts

text

String

Description of notes

isDeletable

Boolean

NA

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 811

{
  "id" : 52,
  "uuid" : "98085731BD964D9BA9114D4927C741A0",
  "text" : "Notes 123",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205659710,
  "updatedOn" : 1773205659710,
  "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/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes?parentEntityUuid=80862411135A47AA9F0B2689B86B873B&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 /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/notes?parentEntityUuid=80862411135A47AA9F0B2689B86B873B&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: 877

{
  "data" : [ {
    "id" : 52,
    "uuid" : "98085731BD964D9BA9114D4927C741A0",
    "text" : "Notes 123",
    "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "isArchived" : false,
    "userOwner" : {
      "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
      "name" : "rcsampleg-smokeuser",
      "userFullName" : "rcsampleg-smokeuser GE",
      "firstName" : "rcsampleg-smokeuser",
      "lastName" : "GE",
      "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
      "id" : 2,
      "isActive" : true,
      "createdOn" : 1773204962375,
      "updatedOn" : 1773204962375
    },
    "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "isPrivateNote" : false,
    "createdOn" : 1773205659710,
    "updatedOn" : 1773205659710,
    "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/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 '[ {
  "text" : "first note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "second  note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "third note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
} ]'

Example HTTP request

POST /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: 496
Host: www.predixapis.com

[ {
  "text" : "first note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "second  note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
}, {
  "text" : "third note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "isArchived" : false,
  "isPrivateNote" : false,
  "isDeletable" : false
} ]

Request Structure

Path Type Description

[]

Array

[].isPrivateNote

Boolean

true if its Internal Note, false otherwise

[].parentEntityUuid

String

ID of parent alarm

[].text

String

Description of notes

[].isArchived

Boolean

can add notes only for active alerts

[].isDeletable

Boolean

NA

*Required fields

Example response

HTTP/1.1 200 OK
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 2350

[ {
  "id" : 53,
  "uuid" : "9B958FF4F08D4769BD1694178FEE0B2C",
  "text" : "first note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205659793,
  "updatedOn" : 1773205659793,
  "isDeletable" : true
}, {
  "id" : 54,
  "uuid" : "C6B27E20810340E0B01F5565F857D269",
  "text" : "second  note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205659793,
  "updatedOn" : 1773205659793,
  "isDeletable" : true
}, {
  "id" : 55,
  "uuid" : "F4BB6AEB747443B285AADD480E84B735",
  "text" : "third note",
  "parentEntityUuid" : "80862411135A47AA9F0B2689B86B873B",
  "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
  "isArchived" : false,
  "userOwner" : {
    "uuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
    "name" : "rcsampleg-smokeuser",
    "userFullName" : "rcsampleg-smokeuser GE",
    "firstName" : "rcsampleg-smokeuser",
    "lastName" : "GE",
    "tenantId" : "f743b7ef-42df-4d7e-89dd-90dc3b53b0ac",
    "id" : 2,
    "isActive" : true,
    "createdOn" : 1773204962375,
    "updatedOn" : 1773204962375
  },
  "userOwnerUuid" : "88c29d94-a058-4594-9b2c-d8e0e5924d48",
  "isPrivateNote" : false,
  "createdOn" : 1773205659794,
  "updatedOn" : 1773205659794,
  "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/v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/attachments?parentEntityUuid=80862411135A47AA9F0B2689B86B873B&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'

Example HTTP request

POST /v3/tenants/f743b7ef-42df-4d7e-89dd-90dc3b53b0ac/alarms/attachments?parentEntityUuid=80862411135A47AA9F0B2689B86B873B&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=file; filename=blog.txt
Content-Type: text/plain

text
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Structure

Part Description

file

The file to upload

*Required fields

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/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/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,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 225
Host: www.predixapis.com

{
  "disposition" : [ {
    "name" : "Alarm-Disposition-Name",
    "description" : "alarm-description",
    "isActive" : true,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].displayOrder

Number

displayorder of tenant configuration

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].name

String

name of tenant configuration

disposition[].description

String

description of disposition

disposition[].uuid

String

Unique ID of disposition

disposition[].locale

String

Language of disposition

disposition[].isActive

Boolean

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/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" : 1564,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}'

Example HTTP request

POST /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: 204
Host: www.predixapis.com

{
  "disposition" : [ {
    "id" : 1564,
    "description" : "alarm-description",
    "isActive" : false,
    "isSystem" : true,
    "displayOrder" : 1,
    "uuid" : "uuid",
    "locale" : "en-US"
  } ]
}

Request structure

Path Type Description

disposition[].id

Number

id of tenant configuration

disposition[].description

String

Description of the disposition

disposition[].uuid

String

uuid of the disposition

disposition[].displayOrder

Number

display order for tenant configuration

disposition[].isSystem

Boolean

whether system generated default or user specific config

disposition[].locale

String

language of name

disposition[].isActive

Boolean

false if tenant configuration is deprecated, true otherwise

*Required fields

Example response

HTTP/1.1 500 Internal Server Error
X-B3-TraceId: 486f31bee32a9a2
Content-Type: application/json
Content-Length: 186

{
  "path" : "",
  "requestId" : "712b24f4-53bf-487e-b04f-54ed073184f8",
  "errorId" : "SERVICE_FAILURE",
  "errorMessage" : "Contact support.",
  "timestamp" : "2026-03-11T05:07+0000"
}

Getting Custom Attributes

A GET request is used get custom attributes.

Example CURL request

$ curl 'https://www.predixapis.com/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 /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: 195

[ {
  "id" : 6,
  "attributeName" : "testAttributeV3Tenants",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
} ]

Response structure

Path Type Description

[].id

Number

id of custom attribute

[].attributeName

String

variable name of custom attribute

[].displayName

String

display name of custom attribute

[].attributeType

String

the value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

[].visibility

Boolean

visibility of custom attribute on front end

[].minValue

Number

min value of NUMBER type custom attribute

[].maxValue

Number

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/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 '{
  "attributeName" : "testAttributeV3Tenants",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}'

Example HTTP request

POST /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: 179
Host: www.predixapis.com

{
  "attributeName" : "testAttributeV3Tenants",
  "displayName" : "Test Attribute",
  "attributeType" : "NUMBER",
  "visibility" : true,
  "minValue" : 0.0,
  "maxValue" : 100.0
}

Request structure

Path Type Description

attributeName

String

*The name that will represent the custom attribute value. Cannot already exist in the tenant.

displayName

String

*The display name of the custom attribute, which will be shown on the front-end.

attributeType

String

*The value type of the custom attribute (TEXT, NUMBER, BOOLEAN, OBJECT, ARRAY, NULL).

visibility

Boolean

*Boolean whether the custom attribute will be displayed on the front-end.

minValue

Number

*The minimum value the custom attribute can be (only applies to type NUMBER).

maxValue

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: 191

{
  "id" : 6,
  "attributeName" : "testAttributeV3Tenants",
  "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/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 /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

entityTypeSubscriptions

Object

Subscriptions

entityTypeSubscriptions.ALERT[]

Array

Value is ALERT or CASES depending on where latched alert needs to be created

entityTypeSubscriptions.ALERT[].complexWatchable

Object

Collection of fields and filters required to create latched alert

entityTypeSubscriptions.ALERT[].complexWatchable.entityType

String

Value can be ALERT or CASES depending on the rule where latched alert needs to be created

entityTypeSubscriptions.ALERT[].complexWatchable.trigger

String

Either ALERT_CREATED or ALERT_DISPOSITION_UPDATED depending on the condition

entityTypeSubscriptions.ALERT[].complexWatchable.fieldExpressions.filters

Array

Set of filters that can be applied→ Severity, Source, Alert Type, Alert Name

entityTypeSubscriptions.ALERT[].complexWatchable.actionTypeId

Number

Id of action type

entityTypeSubscriptions.ALERT[].complexWatchable.actionValue

Object

Action to be taken upon creation

*Required fields

Example response

HTTP/1.1 200 OK