{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Alarm Cycle APIs","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"alarm-cycle-apis","__idx":0},"children":["Alarm Cycle APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alarm Cycle APIs provides a set of APIs to query and modify alarm cycles"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"background","__idx":1},"children":["Background"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alarm"]},": an alarm is usually generated by downstream algorithms and related to a container, such as a well."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Alarm histories"]},": some operations performed on an alarm can create an alarm history, for example: an alarm state changed, alarm escalated, etc."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":2},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What is Cycle in Alarm service:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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”."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A cycle must start with “Active” state history and end with “Inactive” state history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Not all histories belong to a cycle. A history that is not between any “Active” and “Inactive” histories does not belong to any cycle."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/cycle.fd5f55d775ccfbbe897ce276321755000acfcbb398f1c7bfad630b32e964ebd5.7b36dfd9.png","alt":"Alarm Cycles"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The relationship between alarm, alarm cycles, and alarm histories"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/cycle_relation.186c7abc76eba517c0d87d788e5e2b4f9d8bc8ff14a1d3e11bdb422aa4a6ed1d.7b36dfd9.png","alt":"Alarm Cycles Relationship"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-design","__idx":3},"children":["API Design"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#ffffff","backgroundColor":"#49CC90","padding":"2px 5px","borderRadius":"3px"}},"children":["POST"]}," /cycles"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supported on Delfi Developer Portal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This is the cycle search Api that can search for cycles by a set of conditions with pagination."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All filters are optional. If no filter is provided, default cycles during the last 7 days will be provided."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Multiple filters are applied together with 'AND' logic, but array elements are applied with “OR” logic."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["user token is needed to use this Api"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Notes for some request input fields:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parent Field Name"},"children":["Parent Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["systemStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values should be '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Active"]},"' or '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inactive"]},"'"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["severities"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values should be '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Low"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Medium"]},"' or '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["High"]},"'"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["voteStatus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["enum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values should be '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unvoted"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["True"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["False"]},"' or '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NA"]},"'"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keyword"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 'Keyword' filter will search in '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WellName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WellboreName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RigName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Source"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AlarmTyp"]},"e', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LastVotedBy"]},"' fields."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["start, end"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter/timeRange"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DateTimeOffset"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Example value format is: \"",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2025-07-30T07:54:48.600Z"]},"\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sort"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["enum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values should be '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["None"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AlarmType"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Severities"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["VoteStatus"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WellName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["WellboreName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RigName"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Source"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["StartTime"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EndTime"]},"', '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LastVotedTime"]},"', or '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LastVotedBy"]},"'"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sortDirection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sort"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values should be '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ascending"]},"' or '",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Descending"]},"'"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pageSize"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["paging"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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."]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Notes for some response output fields:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parent Field Name"},"children":["Parent Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cycle Id"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availability"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["availability could be \"PRODUCER\" or \"CUSTOMER\". \"PRODUCER\" represents SLB data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["containerId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["a container could be a well, wellbore, datapartition or etc. Currently only support well level."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["feedback"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["a list of feedbacks for this alarm"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["escalation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The escalation status"]}]}]}]}]}]},"headings":[{"value":"Alarm Cycle APIs","id":"alarm-cycle-apis","depth":1},{"value":"Background","id":"background","depth":2},{"value":"Introduction","id":"introduction","depth":2},{"value":"API Design","id":"api-design","depth":2}],"frontmatter":{"seo":{"title":"Alarm Cycle APIs"}},"lastModified":"2026-09-17T14:20:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillops/docs/tutorials/api-guide/alarm-cycle-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}