MessagingResource
Messaging resource to access the inbox (list, view, mark read, delete) and send messages
The following resources are applicable:
/msg/list
Mount Point: /CNPortletapp/rest/msg/list
GET
List messages for the current user
Parameters
name | description | type | default |
---|---|---|---|
unread | true if only unread messages shall be shown, false for all messages (default) | query | false |
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
response containing the messages
/msg/read
Mount Point: /CNPortletapp/rest/msg/read
POST
Set messages to be read
Request Body
element: | messagesReadRequest |
media types: | */* application/xml application/json |
request containing the list of messages to be set read
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
generic response
/msg/send
Mount Point: /CNPortletapp/rest/msg/send
POST
Send a message to users/groups
Request Body
element: | messageSendRequest |
media types: | */* application/xml application/json |
request to send messages
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
generic response