Jump to

• Request
• Response

Get Notification Profiles

get

/api/notification/Profiles

Gets the notification profiles that match the specified parameters. If no parameters are specified, all notification profiles are returned.

Request

Query Parameters

• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  Example:

  100

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/notificationProfilesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/notificationProfilesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object notificationProfilesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/notificationProfilesRead"
    }
}

Nested Schema : notificationProfilesRead

Type: object

Show Source

• BackupEmailPass: string
  Password for the Backup Email Server user

  Example: password
• BackupEmailPort: integer
  Backup Email Server port

  Example: 25
• BackupEmailServer: string
  FQDN of Backup Email Server

  Example: backup.server.com
• BackupEmailTypeID: integer
  Backup Email Type ID

  Example: 1
• BackupEmailUser: string
  User for the Backup Email Server

  Example: [e-mail]
• ConnectionSecurity: integer
  Email Connection Security Flag Allowed Values: - 0 => Plaintext/None - 1 => SSL (Secure on Connect) - 2 => TLS (Negotiated)

  Example: 0
• PrimaryEmailPass: string
  Password for the Primary Email Server user

  Example: xyzABC123@
• PrimaryEmailPort: integer
  Primary Email Server port

  Example: 25
• PrimaryEmailServer: string
  FQDN of Primary Email Server

  Example: primary.server.com
• PrimaryEmailTypeID: integer
  Primary Email Type ID

  Example: 1
• PrimaryEmailUser: string
  User for the Primary Email Server

  Example: [e-mail]
• ProfileDescription: string
  Profile Description

  Example: This is the Generic Unified Assurance Profile for Email
• ProfileID: integer
  Profile ID

  Example: 1
• ProfileName: string
  Name for the Notification Profile.

  Example: Generic Email
• ProfileTypeID: integer
  ID of Notification Profile Type. Possible values: - 1 => Email - 2 => Syslog - 3 => SNMP Trap

  Example: 1
• ProfileTypeName: string
  Name of Notification Profile Type.

  Example: Email
• SSLVerify: boolean
  Flag to indicate whether SSL certificate authentication is needed

  Example: 1
• SyslogPort: integer
  Syslog server port

  Example: 80
• SyslogServers: string
  FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.

  Example:
• Timeout: integer
  Timeout (in seconds) for Email server connection

  Example: 30
• TrapPort: integer
  Trap Servers port

  Example:
• TrapServers: string
  FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.

  Example:

{
    "properties":{
        "ProfileID":{
            "description":"Profile ID",
            "type":"integer",
            "example":1
        },
        "ProfileTypeID":{
            "description":"ID of Notification Profile Type. \n\nPossible values: \n- 1 => Email\n- 2 => Syslog\n- 3 => SNMP Trap",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Name of Notification Profile Type.",
            "type":"string",
            "example":"Email"
        },
        "ProfileName":{
            "description":"Name for the Notification Profile.",
            "type":"string",
            "example":"Generic Email"
        },
        "ProfileDescription":{
            "description":"Profile Description",
            "type":"string",
            "example":"This is the Generic Unified Assurance Profile for Email"
        },
        "PrimaryEmailServer":{
            "description":"FQDN of Primary Email Server",
            "type":"string",
            "example":"primary.server.com"
        },
        "PrimaryEmailPort":{
            "description":"Primary Email Server port",
            "type":"integer",
            "example":25
        },
        "PrimaryEmailTypeID":{
            "description":"Primary Email Type ID",
            "type":"integer",
            "example":1
        },
        "PrimaryEmailUser":{
            "description":"User for the Primary Email Server",
            "type":"string",
            "example":"[e-mail]"
        },
        "PrimaryEmailPass":{
            "description":"Password for the Primary Email Server user",
            "type":"string",
            "example":"xyzABC123@"
        },
        "BackupEmailServer":{
            "description":"FQDN of Backup Email Server",
            "type":"string",
            "example":"backup.server.com"
        },
        "BackupEmailPort":{
            "description":"Backup Email Server port",
            "type":"integer",
            "example":25
        },
        "BackupEmailTypeID":{
            "description":"Backup Email Type ID",
            "type":"integer",
            "example":1
        },
        "BackupEmailUser":{
            "description":"User for the Backup Email Server",
            "type":"string",
            "example":"[e-mail]"
        },
        "BackupEmailPass":{
            "description":"Password for the Backup Email Server user",
            "type":"string",
            "example":"password"
        },
        "ConnectionSecurity":{
            "description":"Email Connection Security Flag\n\nAllowed Values:\n- 0 => Plaintext/None\n- 1 => SSL (Secure on Connect)\n- 2 => TLS (Negotiated)",
            "type":"integer",
            "example":0
        },
        "SSLVerify":{
            "description":"Flag to indicate whether SSL certificate authentication is needed",
            "type":"boolean",
            "example":"1"
        },
        "Timeout":{
            "description":"Timeout (in seconds) for Email server connection",
            "type":"integer",
            "example":30
        },
        "SyslogServers":{
            "description":"FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "SyslogPort":{
            "description":"Syslog server port",
            "type":"integer",
            "example":80,
            "nullable":true
        },
        "TrapServers":{
            "description":"FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "TrapPort":{
            "description":"Trap Servers port",
            "type":"integer",
            "example":"",
            "nullable":true
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top