REST API for Oracle Commerce Cloud December 2017

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: Type: integer

The number of items per block
offset: Type: integer

startingIndex the index of the first record to load
q: Type: 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: Type: string

Sort Option id: Sort order
totalResults: Type: boolean

flag to include count of total notifications

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getMessages_response

Properties

items: Type: array items

Additional Properties Allowed:

Items of publish changes.
limit: Type: integer

Limit of number of changes.
offset: Type: integer

Offset.
sort: Type: array sort

Additional Properties Allowed:

Sort information of the notifications.
total: Type: integer

Total number of changes published. Deprecated.
totalResults: Type: integer

Total number of changes published.

Nested Schema : items

Type: array

Items of publish changes.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

Sort information of the notifications.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

count: Type: integer

1 for simple notification and >1 for rolled up notification.
createdDate: Type: string

Date time when notification was created.
details: Type: string

Detailed information formatted as JSON payload..
id: Type: string

Id of notification.
key: Type: string

Key to roll up notification.
message: Type: string

Message content in notification.
pinned: Type: boolean

Is this notification pinned?
rolledUp: Type: boolean

Is this notification rolled up?
viewedDate: Type: string

Date time when notification was viewed.

Nested Schema : items

Type: object

Properties

order: Type: string

Order of notifications.
property: Type: string

Property of changes say display name.

Example 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.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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"
  }]
}