Resource URL: /platform/<<version=1>>/quota/settings/notifications

    Overview: This resource applies the standard collection item pattern to the
              global notification rules.

     Methods: GET, POST, DELETE

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

Method GET: List all rules.

       URL: GET /platform/<<version=1>>/quota/settings/notifications

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "notifications": {
      "items": {
        "type": "object", 
        "properties": {
          "action_email_owner": {
            "required": true, 
            "type": "boolean", 
            "description": "Email quota domain owner when rule matches."
          }, 
          "email_template": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Path of optional /ifs template file used for email actions."
          }, 
          "schedule": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Schedule for rules that repeatedly notify."
          }, 
          "action_email_address": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Email a specific email address when rule matches."
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "The system ID given to the rule."
          }, 
          "holdoff": {
            "required": true, 
            "type": [
              "integer", 
              "null"
            ], 
            "description": "Time to wait between detections for rules triggered by user actions."
          }, 
          "threshold": {
            "enum": [
              "hard", 
              "soft", 
              "advisory"
            ], 
            "type": "string", 
            "description": "The quota threshold detected.", 
            "required": true
          }, 
          "action_alert": {
            "required": true, 
            "type": "boolean", 
            "description": "Send alert when rule matches."
          }, 
          "condition": {
            "enum": [
              "exceeded", 
              "denied", 
              "violated", 
              "expired"
            ], 
            "type": "string", 
            "description": "The condition detected.", 
            "required": true
          }
        }
      }, 
      "type": "array"
    }, 
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }
  }
}

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

Method POST: Create a new global notification rule.

        URL: POST /platform/<<version=1>>/quota/settings/notifications

There are no query arguments for this method.

Required POST request body fields:
threshold, condition

POST request body schema:
{
  "type": "object", 
  "properties": {
    "action_email_owner": {
      "type": "boolean", 
      "description": "Email quota domain owner when rule matches."
    }, 
    "email_template": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Path of optional /ifs template file used for email actions."
    }, 
    "schedule": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Schedule for rules that repeatedly notify."
    }, 
    "action_email_address": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Email a specific email address when rule matches."
    }, 
    "holdoff": {
      "type": [
        "integer", 
        "null"
      ], 
      "description": "Time to wait between detections for rules triggered by user actions."
    }, 
    "threshold": {
      "enum": [
        "hard", 
        "soft", 
        "advisory"
      ], 
      "type": "string", 
      "description": "The quota threshold detected.", 
      "required": true
    }, 
    "action_alert": {
      "type": "boolean", 
      "description": "Send alert when rule matches."
    }, 
    "condition": {
      "enum": [
        "exceeded", 
        "denied", 
        "violated", 
        "expired"
      ], 
      "type": "string", 
      "description": "The condition detected.", 
      "required": true
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}

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

Method DELETE: Delete all rules.

          URL: DELETE /platform/<<version=1>>/quota/settings/notifications

There are no query arguments for this method.

There is no response body for this method.
