getMessages
get
/ccadmin/v1/notificationMessages
Get Messages. Get a list of notification messages. Supports standard SCIM querying.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items per block
-
offset(optional): integer
startingIndex the index of the first record to load
-
q(optional): string
A SCIM filter string for selecting a subset of all products. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Examples: Get all products whose displayName contains shirt: q=displayName co "shirt" Get all products with an orderLimit between 5 and 10: q=orderLimit gt 5 and orderLimit lt 10 Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted.
-
sort(optional): string
Sort Option id: Sort order
-
totalResults(optional): boolean
flag to include count of total notifications
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getMessages_response
Type:
Show Source
object
-
items(optional):
array items
Items of publish changes.
-
limit(optional):
integer
Limit of number of changes.
-
offset(optional):
integer
Offset.
-
sort(optional):
array sort
Sort information of the notifications.
-
total(optional):
integer
Total number of changes published. Deprecated.
-
totalResults(optional):
integer
Total number of changes published.
Nested Schema : items
Type:
Show Source
object
-
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.
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Order of notifications.
-
property(optional):
string
Property of changes say display name.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/notificationMessages"
}
],
"sort":[
{
"property":"createdDate",
"order":"asc"
}
],
"items":[
{
"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\"}",
"id":"931269",
"message":"This is Failing",
"key":"test"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|51200|Internal Error.|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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