Request list of notification configurations

v1.0.0

🚀 Since v4.20.0

Description:

Retrieve a list of notification configurations for current user.

Precondition:

Authenticated user.

Postcondition:

List of available notification configurations is returned.

Further Information:

None.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of notification configurations",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of notification configurations",
      "items": {
        "type": "object",
        "description": "Notification configuration information",
        "required": [
          "channelIds",
          "eventTypeName",
          "id",
          "scopeId"
        ],
        "properties": {
          "channelIds": {
            "type": "array",
            "description": "List of notification channel IDs",
            "items": {
              "type": "integer",
              "format": "int32",
              "description": "List of notification channel IDs"
            }
          },
          "eventTypeName": {
            "type": "string",
            "description": "Event type name"
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Notification configuration ID"
          },
          "scopeId": {
            "type": "integer",
            "format": "int32",
            "description": "Scope ID"
          }
        }
      }
    }
  }
}