Alarm Cycle APIs provides a set of APIs to query and modify alarm cycles
Alarm: an alarm is usually generated by downstream algorithms and related to a container, such as a well.
Alarm histories: some operations performed on an alarm can create an alarm history, for example: an alarm state changed, alarm escalated, etc.
What is Cycle in Alarm service:
A Cycle is an object representing a set of consecutive Alarm history items starting from an active state to the first resolved state, currently resolved state is “Inactive”.
- A cycle must start with “Active” state history and end with “Inactive” state history
- Not all histories belong to a cycle. A history that is not between any “Active” and “Inactive” histories does not belong to any cycle.
The relationship between alarm, alarm cycles, and alarm histories
POST /cycles
- Supported on Delfi Developer Portal
- This is the cycle search Api that can search for cycles by a set of conditions with pagination.
- All filters are optional. If no filter is provided, default cycles during the last 7 days will be provided.
- Multiple filters are applied together with 'AND' logic, but array elements are applied with “OR” logic.
- user token is needed to use this Api
- Notes for some request input fields:
| Field Name | Parent Field Name | Type | Notes |
|---|---|---|---|
| systemStatus | filter | string | Values should be 'Active' or 'Inactive' |
| severities | filter | string | Values should be 'Low', 'Medium' or 'High' |
| voteStatus | filter | enum | Values should be 'Unvoted', 'True', 'False' or 'NA' |
| keyword | filter | string | The 'Keyword' filter will search in 'WellName', 'WellboreName', 'RigName', 'Source', 'AlarmType', 'LastVotedBy' fields. |
| start, end | filter/timeRange | DateTimeOffset | Example value format is: "2025-07-30T07:54:48.600Z" |
| field | sort | enum | Values should be 'None', 'AlarmType', 'Status', 'Severities', 'VoteStatus', 'WellName', 'WellboreName', 'RigName', 'Source', 'StartTime', 'EndTime', 'LastVotedTime', or 'LastVotedBy' |
| sortDirection | sort | string | Values should be 'Ascending' or 'Descending' |
| pageSize | paging | int | pageSize should be between 20 – 100 (Inclusive). If pageSize is smaller than 20 or greater than 100, pageSize will be set to 20 and 100 respectively. |
- Notes for some response output fields:
| Field Name | Parent Field Name | Type | Notes |
|---|---|---|---|
| id | items | string | cycle Id |
| availability | items | object | availability could be "PRODUCER" or "CUSTOMER". "PRODUCER" represents SLB data. |
| containerId | items | string | a container could be a well, wellbore, datapartition or etc. Currently only support well level. |
| feedback | items | object | a list of feedbacks for this alarm |
| escalation | items | object | The escalation status |