Jump to

• Request
• Response

getNotification

get

/ccadmin/v1/notificationMessages/{id}

Get Notification. Get the notification.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Id of notification.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getNotification_response

Type: object

Show Source

• count(optional): integer
  1 for simple notification and >1 for rolled up notification.
• createdDate(optional): string
  Date time when notification was created.
• details(optional): string
  Detailed information formatted as JSON payload..
• id(optional): string
  Id of notification.
• key(optional): string
  Key to roll up notification.
• message(optional): string
  Message content in notification.
• pinned(optional): boolean
  Is this notification pinned?
• rolledUp(optional): boolean
  Is this notification rolled up?
• viewedDate(optional): string
  Date time when notification was viewed.

{
    "properties":{
        "viewedDate":{
            "description":"Date time when notification was viewed.",
            "type":"string"
        },
        "rolledUp":{
            "description":"Is this notification rolled up?",
            "type":"boolean"
        },
        "pinned":{
            "description":"Is this notification pinned?",
            "type":"boolean"
        },
        "createdDate":{
            "description":"Date time when notification was created.",
            "type":"string"
        },
        "count":{
            "description":"1 for simple notification and >1 for rolled up notification.",
            "type":"integer"
        },
        "details":{
            "description":"Detailed information formatted as JSON payload..",
            "type":"string"
        },
        "id":{
            "description":"Id of notification.",
            "type":"string"
        },
        "message":{
            "description":"Message content in notification.",
            "type":"string"
        },
        "key":{
            "description":"Key to roll up notification.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "viewedDate":null,
    "rolledUp":false,
    "pinned":false,
    "createdDate":"2016-10-19T19:46:11.754Z",
    "count":1,
    "details":"{\"Type\":\"test\",\"rate\":2.55,\"http code\":500,\"Date\":\"2016-10-19T19:46:11.753Z\"}",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/notificationMessages/931269"
        }
    ],
    "id":"931269",
    "message":"This is Failing",
    "key":"test"
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top