Skip to main content
Loading...

API docs by

Get Network Notification

Request

This API retrieves the details of a user's network notification by its identification ID number.

Path
idstringrequired

Network Notification Id of the record need to load.

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
idstringrequired

Notification Identification.

Example:"5-122662504647"
typestring(network-notification-type)required

Notification Type.

Enum:"NETWORK_INCIDENT""NETWORK_MAINTENANCE"
Example:"NETWORK_MAINTENANCE"
startTimestampstring, (date-time)required

Event/Notification start date.

Example:"2018-01-28T03:46:36.720Z"
endTimestampstring, (date-time)

Event/Notification start date.

Example:"2018-01-29T03:46:36.720Z"
ibxsArray of stringsrequired

List of IBX

Example:
[
  "SG1",
  "SG2"
]
statusstring(notification-status)required

Event/Notification Status.

Enum:"EXTENDED""RESCHEDULED""CANCELLED""COMPLETED""IN_PROGRESS""RESOLVED""UPDATED""NEW""OTHER"
Example:"RESOLVED"
productTypesArray of strings

List of network product type (example: ETHERNET_EXCHANGE, INTERNET_EXCHANGE, CROSS_CONNECT, METRO_CONNECT, CLOUD_IX). It may return UNKNOWN if no known product type is found.

Example:
[
  "INTERNET_EXCHANGE",
  "METRO_CONNECT"
]
summarystring

Summary information about the event / notification.

Example:"line card replacement of dis01.wa1"
emailsArray of objects(NotificationEmail)

Event/Notification Email Content

Response
{
  "id": "5-122662504647",
  "type": "NETWORK_MAINTENANCE",
  "startTimestamp": "2018-01-28T03:46:36.720Z",
  "endTimestamp": "2018-01-29T03:46:36.720Z",
  "ibxs": [
    "SG1",
    "SG2"
  ],
  "status": "RESOLVED",
  "productTypes": [
    "INTERNET_EXCHANGE",
    "METRO_CONNECT"
  ],
  "summary": "line card replacement of dis01.wa1",
  "emails": [
    { … }
  ]
}
Was this page helpful?