REST — Server Events

Server events can be accessed for reference and disabled for the session. Server events cannot currently be created or edited using REST.

All requests require a Session Id URL parameter and basic request headers. In the following topic, headers are omitted in the interest of brevity.

Server Event JSON

Server events are represented as JSON objects with the following properties:

Example

{
  "Id":   "0",
  "Name": "RunAfterReportExecution"
}

List Server Events

List all the server events in the current configuration. Output is an array of objects, each representing an individual server event.

GET /rest/ServerEvents

Using curl

curl http://{webservice}/rest/ServerEvents?sid={sid} -X GET

Example response

Status: 200 OK
[
  {
    "Id":   "0",
    "Name": "RunAfterReportExecution"
  },
  {
    "Id":   "1",
    "Name": "AddDisclaimerToOutput"
  }
]

Show Server Event

Show the properties of the server event specified by its Id.

GET /rest/ServerEvents/{Id}

Using curl

curl http://{webservice}/rest/ServerEvents/{Id}?sid={sid} -X GET

Example response

Status: 200 OK
{
  "Id":   "0",
  "Name": "RunAfterReportExecution"
}

Delete Server Event

DELETE /rest/ServerEvents/{Id}

Using curl

curl http://{webservice}/rest/ServerEvents/{Id}?sid={sid} -X DELETE

Example response

Status: 204 No Content