Resource URL: /platform/<<version=3>>/event/eventgroup-occurrences

    Overview: This resource applies the standard collection pattern to
              eventgroup occurrences.

     Methods: GET, PUT

********************************************************************************

Method GET: List all eventgroup occurrences.

       URL: GET /platform/<<version=3>>/event/eventgroup-occurrences

Query arguments:
                 sort=<string> The field that will be used for sorting.
            resolved=<boolean> Filter for resolved eventgroups
               begin=<integer> events that are in progress after this time
                 end=<integer> events that were in progress before this time
               severity=<enum> Where <enum> is one of information, warning,
                               critical, emergency.  Filter for severity (PAPI
                               list accepted)
         event_count=<integer> events for which event_count > this
               devid=<integer> Filter for devid (PAPI list accepted)
               resume=<string> Continue returning results from previous call
                               using this token (token should come from the
                               previous call, resume cannot be used with other
                               options).
              ignore=<boolean> Filter for ignored eventgroups
      last_event_end=<integer> Filter eventgroups by those that have last_event
                               before this time.
               limit=<integer> Return no more than this many results at once
                               (see resume).
                    dir=<enum> Where <enum> is one of ASC, DESC.  The direction
                               of the sort.
             resolver=<string> Filter for eventgroup resolver
partial_eventgroup_id=<string> Filter by partial eventgroup id
   partial_event_type=<string> Filter eventgroups by there associated event's
                               event-type number.
                cause=<string> Filter for cause
   partial_cause_long=<string> Filter by partial long-cause description.
    last_event_begin=<integer> Filter eventgroups by those that have last_event
                               after this time.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "eventgroups": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Record of a eventgroup occurrence.", 
            "properties": {
              "resolved": {
                "type": "boolean", 
                "description": "True if eventgroup is resolved."
              }, 
              "ignore": {
                "type": "boolean", 
                "description": "True if eventgroup is marked as 'ignore'."
              }, 
              "severity": {
                "type": "string", 
                "description": "Event Group severity."
              }, 
              "event_count": {
                "type": "integer", 
                "description": "Number of events linked to this eventgroup."
              }, 
              "ignore_time": {
                "type": "integer", 
                "description": "Time eventgroup was marked as 'ignore'."
              }, 
              "time_noticed": {
                "type": "integer", 
                "description": "Time of first event linked to this eventgroup."
              }, 
              "last_event": {
                "type": "integer", 
                "description": "Time the most recent event was added to this eventgroup."
              }, 
              "sequence": {
                "type": "integer", 
                "description": "Unique sequence number assigned to the eventgroup, by order of creation."
              }, 
              "eventgroup_instance": {
                "type": "string", 
                "description": "Unique identifier of eventgroup instance."
              }, 
              "channels": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "List of channels to which alerts are configured for this eventgroup."
              }, 
              "resolver": {
                "type": "string", 
                "description": "'USER' if the eventgroup was marked resolved via PAPI <event_instance> if eventgroup was marked resolved as a result of an event."
              }, 
              "specifier": {
                "type": "object", 
                "description": "A collection of parameters defined per eventgroup_id."
              }, 
              "resolve_time": {
                "type": "integer", 
                "description": "When the eventgroup became resolved."
              }, 
              "id": {
                "type": "string", 
                "description": "Same as eventgroup_instance."
              }, 
              "causes": {
                "items": {
                  "items": {
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Event Group cause as name and description"
                }, 
                "type": "array", 
                "description": "List of eventgroup IDs that may be causes of this occurrence."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify all eventgroup occurrences, resolve or ignore all

       URL: PUT /platform/<<version=3>>/event/eventgroup-occurrences

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Ignore flag for eventgroup.", 
  "properties": {
    "ignore": {
      "type": "boolean", 
      "description": "True if eventgroup is to be ignored"
    }, 
    "resolved": {
      "type": "boolean", 
      "description": "True if eventgroup is to be resolved"
    }
  }
}

There is no JSON response body for this method.
