Manage Alerts

Alerts created from these sensor data give you information about the condition of the Technical Object. The information provided helps you with any potential failure that may occur or has already occurred for the Technical Object and helps to identify potential actions to be taken for the incoming alerts.This service is located at [/AlertsService/v1/Alert]
Version: 1.0.0
BasePath:/AlertsService/v1/Alert

Access

  1. OAuth AuthorizationUrl:TokenUrl:https://{subdomain(identity_zone)}.authentication.{domain}/oauth/token?grant_type=client_credentials
  2. APIKey KeyParamName:X-API-KEY KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Alert

Alert

Up
get /Alert
Retrieve a list of alert. (alertGet)

Query parameters

$top (optional)
Query Parameter — Show only the first n items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop">Paging - Top</a>
$skip (optional)
Query Parameter — Skip the first n items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip">Paging - Skip</a>
$search (optional)
Query Parameter — Search items by search phrases, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch">Searching</a>
$filter (optional)
Query Parameter — Filter items by property values, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter">Filtering</a>
$count (optional)
Query Parameter — Include count of items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount">Count</a>
$orderby (optional)
Query Parameter — Order items by property values, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby">Sorting</a>
$select (optional)
Query Parameter — Select properties to be returned, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect">Select</a>
$expand (optional)
Query Parameter — The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand">Expand</a>

Return type

Collection of Alert

Example data

Content-Type: application/json
{
  "@odata.count" : "",
  "value" : [ {
    "TriggeredOn": "2024-05-16T06:01:08.846Z",
    "Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
    "FirstOccurredOn": "2024-05-16T06:01:08.846Z",
    "LastOccurredOn": "2024-05-16T06:01:08.846Z",
    "UpdatedOn": "2024-05-16T06:10:26.021Z",
    "AlertTypeDescription": "Sep-18",
    "AlertType": "TestPublicAlert",
    "Status": "10",
    "StatusDescription": "In_Process",
    "Severity": 5,
    "SeverityDescription": "Warning",
    "Source": "API",
    "DeduplicationCount": "0"
  }, {
    "TriggeredOn": "2024-05-16T06:01:08.846Z",
    "Id": "427ee2ed-bbfd-425e-9f52-b0ae52be89bc",
    "FirstOccurredOn": "2024-05-16T06:01:08.846Z",
    "LastOccurredOn": "2024-05-16T06:01:08.846Z",
    "UpdatedOn": "2024-05-16T06:10:26.021Z",
    "AlertTypeDescription": "Sep-18",
    "AlertType": "TestPublicAlert",
    "Status": "10",
    "StatusDescription": "In_Process",
    "Severity": 5,
    "SeverityDescription": "Warning",
    "Source": "API",
    "DeduplicationCount": "0"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved alert Collection of Alert

4XX

Error error

Up
get /Alert('{Id}')
Retrieve a single alert. (alertIdGet)

Path parameters

Id (required)
Path Parameter — key: Id

Query parameters

$select (optional)
Query Parameter — Select properties to be returned, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect">Select</a>
$expand (optional)
Query Parameter — The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand">Expand</a>

Return type

PublicAlertsService.Alert

Example data

Content-Type: application/json
{
    "TriggeredOn": "2024-05-16T06:01:08.846Z",
    "Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
    "FirstOccurredOn": "2024-05-16T06:01:08.846Z",
    "LastOccurredOn": "2024-05-16T06:01:08.846Z",
    "UpdatedOn": "2024-05-16T06:10:26.021Z",
    "AlertTypeDescription": "Sep-18",
    "AlertType": "TestPublicAlert",
    "Status": "10",
    "StatusDescription": "In_Process",
    "Severity": 5,
    "SeverityDescription": "Warning",
    "Source": "API",
    "DeduplicationCount": "0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved alert PublicAlertsService.Alert

4XX

Error error

Up
patch /Alert('{Id}')
Change a single alert. (alertIdPatch)

Path parameters

Id (required)
Path Parameter — key: Id

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter — New property values
{
  "Status": "10"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

4XX

Error error

Up
post /Alert
Create a single alert. (alertPost)
{
    "AlertType": "TestPublicAlert",
    "TriggeredOn": "2024-05-16T06:01:08.846Z",
    "TechnicalObject": [
        {
            "Number": "10000001",
            "SSID": "QM7_910",
            "Type": "EQUI"
        }
    ]
}

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter — New alert

Return type

PublicAlertsService.Alert

Example data

Content-Type: application/json
{
    "TriggeredOn": "2024-05-16T06:01:08.846Z",
    "Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
    "FirstOccurredOn": "2024-05-16T06:01:08.846Z",
    "LastOccurredOn": "2024-05-16T06:01:08.846Z",
    "UpdatedOn": "2024-05-16T06:10:26.021Z",
    "AlertTypeDescription": "Sep-18",
    "AlertType": "TestPublicAlert",
    "Status": "10",
    "StatusDescription": "In_Process",
    "Severity": 5,
    "SeverityDescription": "Warning",
    "Source": "API",
    "DeduplicationCount": "0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created alert PublicAlertsService.Alert

4XX

Error error

Models

[ Jump to Methods ]

Table of Contents

  1. Collection of Alert - Collection of Alert
  2. PublicAlertsService.Alert - Alert
  3. PublicAlertsService.Alert-create - Create Alert
  4. PublicAlertsService.Alert-update - Update Alert
  5. PublicAlertsService.PublicDescriptions - Alert Descriptions
  6. PublicAlertsService.PublicNotification - Alert Notification
  7. PublicAlertsService.PublicTechnicalObject - Alert Technical Object
  8. PublicAlertsService.PublicTechnicalObject-AlertCreate - Technical Object
  9. count
  10. error
  11. error_error
  12. error_error_details

Collection of Alert - Collection of Alert Up

@odata.count (optional)
value (optional)

PublicAlertsService.Alert - Alert Up

TriggeredOn
Date Indicates the actual timestamp “when” the Alert was occured for the Technical Object in real world. format: date-time
example: 2017-04-13T15:51:04Z
Id
String System generated Id for alerts
FirstOccurredOn
Date Indicates the actual timestamp “when” the Alert was created for the Technical Object in real world for the first time. format: date-time
example: 2017-04-13T15:51:04Z
LastOccurredOn
Date Indicates the actual timestamp “when” the Alert was created for the Technical Object for the last time. format: date-time
example: 2017-04-13T15:51:04Z
UpdatedOn
Date Indicates the actual timestamp “when” the Alert was updated for the Technical Object.. format: date-time
example: 2017-04-13T15:51:04Z
AlertTypeDescription
String Indicates an appropriate description that describes the alert type.
AlertType
String Indicates a unique alphanumeric ID for the alert type
Status
String Indicates one of the following statuses for an alert. New – Default status of a newly generated alert(1),In_Process(10),Closed(15),AutoArchived(20)
StatusDescription
String Indicates one of the following statuses description for an alert. New – Default status of a newly generated alert(1),In_Process(10),Closed(15),AutoArchived(20)
Severity
Integer Indicates the Severity of the alerts. This information comes from the Alert Type, and currently below three types are supported: Information(1), Warning(5), Error(10) format: int32
SeverityDescription
String Indicates the Severity description of the alerts, and currently below three types are supported: Information(1), Warning(5), Error(10)
Source
String This allows you to differentiate between the alert type defined for the alert arising from a machine. In our case it will always be API -&gt; Value must be used for the alert type created using APIs.This information comes from Alert Type
DeduplicationCount
String Indicates the count of identical alerts created when the deduplication is active for an alert.When deduplication is active, every instance of an alert within the deduplication period will be considered a single instance, and the deduplication count will increase

PublicAlertsService.Alert-create - Create Alert Up

AlertType (required)
String Indicates a unique alphanumeric ID for the alert type
TriggeredOn (required)
Date Indicates the actual timestamp “when” the Alert was occured for the Technical Object in real world. format: date-time
example: 2017-04-13T15:51:04Z
TechnicalObject (required)

PublicAlertsService.Alert-update - Update Alert Up

Status (required)
String Indicates one of the following statuses for an alert. New – Default status of a newly generated alert(1), In_Process(10), Closed(15), AutoArchived(20)

PublicAlertsService.PublicDescriptions - Alert Descriptions Up

TechnicalObjectDescription
String Indicates the Technical Object description
NotificationDescription
String Indicates the Notification description
Language
String Indicates the language of the technical object and notification based on the geographic, political, or cultural area

PublicAlertsService.PublicNotification - Alert Notification Up

MaintenanceNotification
String Indicates the unique key that helps you identify the maintenance notification number.
CreationDate
Date Indicates the date on which the maintenance notification record was created. format: date-time
example: 2017-04-13T15:51:04Z
SSID
String Indicates the service set identifier (SSID), a unique identification number that is used to identify the tenant

PublicAlertsService.PublicTechnicalObject - Alert Technical Object Up

Number
String Indicates the unique key that helps you identify the technical object number.
Name
String Indicates the unique key that helps you identify the technical object number.
Type
String Indicates the unique key that describes the type of the technical object. Current possible values for type are EQUI (Equipment) and FLOC (Function location).
SSID
String Indicates the service set identifier (SSID), a unique identification number that is used to identify the tenant
SerialNumber
String Indicates the number of the serialized material.
Operator
String Indicates the operator of technical object
PlanningPlant
String Indicates the plant in which maintenance tasks are planned and prepared.
CategoryCode
String Indicates the unique key for distinguishing technical objects according to their use. The usage may be as machinery, device, or customer equipment. For example, Machines (M), Customer Equipment (S), etc.
CategoryDescription
String Indicates the unique key description for distinguishing technical objects according to their use. The usage may be as machinery, device, or customer equipment. For example, Machines (M), Customer Equipment (S), etc.
StatusCode
String Indicates the status of the technical object
StatusDescription
String Indicates the description of the status of the technical object.
PlannerGroup
String Indicates a group of employees responsible for planning and processing maintenance tasks in a plant.
Class1
String Indicates the name of the class
MaintenancePlant
String Indicates the plant in which the technical objects are installed and maintained.
Criticality
String Indicates the list of criticality values displayed is from the SAP ERP. These values correspond to the ABC indicator assigned to a technical object in the SAP ERP.
CostCenter
String Indicates the unique key that identifies a cost center.
MainWorkCenter
String Indicates the main work center that is in charge when a maintenance task is performed on the technical object.
SuperiorFunctionalLocation
String Indicates the functional location, which is hierarchically directly above the functional location that you are creating, changing, or displaying.
SuperordinateEquipment
String Indicates the number that identifies the superior equipment associated with a piece of equipment.

PublicAlertsService.PublicTechnicalObject-AlertCreate - Technical Object Up

Number (required)
String Indicates the unique key that helps you identify the technical object number.
Type (required)
String Indicates the unique key that describes the type of the technical object. Current possible values for type are EQUI (Equipment) and FLOC (Function location).
SSID (required)
String Indicates the service set identifier (SSID), a unique identification number that is used to identify the tenant

count Up

The number of entities in the collection. Available when using the <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount">$count</a> query option.

error Up

error

error_error Up

code
message
target (optional)
details (optional)
innererror (optional)
Object The structure of this object is service-specific

error_error_details Up

code
message
target (optional)