This is the reference document for the REST API and resources provided by Notifications and Tasks. The REST APIs are developers who want to integrate Notifications and Tasks with other standalone or web applications, and administrators who want to script interactions with the Notifications and Tasks server.

Structure of the REST URIs

Notifications and Tasks REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Notifications and Tasks REST API uses JSON as its communication format, and the standard HTTP methods like GET, PUT, POST and DELETE (see API descriptions below for which methods are available for each resource). URIs for Notifications and Tasks REST API resource have the following structure:

http://host:port/context/rest/api-name/api-version/resource-name

The current API version is 1. However, there is also a symbolic version, called latest, which resolves to the latest version supported by the given instance.

There is a WADL document that contains the documentation for each resource in the Notifications and Tasks REST API. It is available here.