ESN REST Interface

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name	path	methods
Authenticated User	`/self` `/self/avatar` `/self/global_preferences` `/self/notifications` `/self/notifications/new_count` `/self/notifications/{id}` `/self/password` `/self/rooms` `/self/rooms/favorites` `/self/rooms/favorites/{room_id}` `/self/rooms/{room_id}` `/self/rooms/{room_id}/preferences`	`GET` `DELETE POST` `GET POST PUT` `GET` `DELETE GET` `GET` `POST` `GET` `GET POST` `DELETE` `GET POST` `GET PUT`
Conversations	`/topics/{id}` `/topics/{id}/attachments` `/topics/{id}/attachments/{attachment_id}` `/topics/{id}/attachments/{attachment_id}/content` `/topics/{id}/comments` `/topics/{id}/comments/{comment_id}` `/topics/{id}/comments/{comment_id}/attachments` `/topics/{id}/comments/{comment_id}/attachments/{attachment_id}` `/topics/{id}/comments/{comment_id}/attachments/{attachment_id}/content` `/topics/{id}/comments/{comment_id}/comments`	`DELETE GET PUT` `GET POST` `DELETE GET` `GET` `GET POST` `DELETE GET PUT` `GET POST` `DELETE GET` `GET` `GET POST`
Miscellaneous	`/release_info`	`GET` `GET`
Rooms	`/rooms` `/rooms/{id}` `/rooms/{id}/feed` `/rooms/{id}/feed/{topic_id}` `/rooms/{id}/members` `/rooms/{id}/members/operations` `/rooms/{id}/members/{member_id}` `/rooms/{id}/topics`	`GET POST` `DELETE GET PUT` `GET` `GET` `GET POST` `POST` `DELETE GET` `GET POST`
Users and Groups	`/groups` `/groups/{id}` `/users` `/users/{id}` `/users/{id}/avatar` `/users/{id}/avatar/scaled` `/users/{id}/avatar/thumbnail`	`GET` `GET` `GET` `GET` `GET` `GET` `GET`

JSON

type	description
ApiObject	A base class for many of the REST data types.
Attachment	Represents a file that is attached to a topic or comment.
Comment	Represents a reply to a topic within a room. Although user can comment on a specific comment within a topic, it doesn't constitute a nested hierarchy. Instead, the comments are maintained in flat and sequential manner within the topic.
CommentReference	A reference to a comment.
GlobalPreferences	A user's global preferences.
Group	Metadata of a group.
HistoryStamp	Represents a date and time when a user performed an action.
Link	A link to a related resource.
MessageCounts	Contains a total number of messages and a number of directed messages.
Notification	Contains details of some action that occurred in the system that should be of particular interest to the recipient of the notification.
NotificationPreferences	Notification preferences.
NotificationType	Represents the type of action that resulted in the generation of a notification.
PagedResults	A list of objects or a portion of the full list.
PrincipalReference	A reference to a user or group.
PrincipalSource	Created by david on 9/6/17.
Reference	A reference to another resource.
Room	Metadata of a room. A room represents a place where users can have discussions and keep files. There are two types of rooms: public: open for all users to see and participate in private: only visible to the room members
RoomFeedItem	A room feed item, consisting of a topic and new message counts since the user last visited the room.
RoomMembership	Represents a user's or group's membership in a room.
RoomMembershipOperation	An operation to apply to a room's membership.
RoomPreferences	A user's room-specific preferences.
RoomReference	A reference to a room.
Topic	Topic represents a top level message within a room.
TopicReference	A reference to a topic.
TreeNode	Node in a `Tree`.
User	A user
UserReference	A reference to a user.
UserRoomDetails	User-specific details for a room, including the last time the user visited the room and the number of new messages in the room since the user last visited.

XML

Default Namespace (schema)
type	description
api	A base class for many of the REST data types.
attachment	Represents a file that is attached to a topic or comment.
comment	Represents a reply to a topic within a room. Although user can comment on a specific comment within a topic, it doesn't constitute a nested hierarchy. Instead, the comments are maintained in flat and sequential manner within the topic.
comment_reference	A reference to a comment.
global_preferences	A user's global preferences.
group	Metadata of a group.
history_stamp	Represents a date and time when a user performed an action.
link	A link to a related resource.
message_counts	Contains a total number of messages and a number of directed messages.
notification	Contains details of some action that occurred in the system that should be of particular interest to the recipient of the notification.
notification_type	Represents the type of action that resulted in the generation of a notification.
notification_preferences	Notification preferences.
results	A list of objects or a portion of the full list.
principal_reference	A reference to a user or group.
principalSource	Created by david on 9/6/17.
reference	A reference to another resource.
room	Metadata of a room. A room represents a place where users can have discussions and keep files. There are two types of rooms: public: open for all users to see and participate in private: only visible to the room members
room_feed_item	A room feed item, consisting of a topic and new message counts since the user last visited the room.
room_membership	Represents a user's or group's membership in a room.
room_membership_operation	An operation to apply to a room's membership.
room_preferences	A user's room-specific preferences.
room_reference	A reference to a room.
topic	Topic represents a top level message within a room.
topic_reference	A reference to a topic.
node	Node in a `Tree`.
user	A user
user_reference	A reference to a user.
user_room_details	User-specific details for a room, including the last time the user visited the room and the number of new messages in the room since the user last visited.

Resources

Data Types

JSON

XML