Server events can be accessed for reference and disabled for the session. Server events cannot currently be created or edited using REST.
Important
All requests require a Session ID URL parameter and basic request headers. In the following document, headers are omitted for clarity.
Server events are represented as JSON objects with the following properties:
Name | Type | Writable | Description |
Id | string | no | The unique Id of this server event |
Name | string | no | The name of this server event |
Note
Access to other properties of server events via REST is not yet implemented.
{ "Id": "0", "Name": "RunAfterReportExecution" }
GET /rest/ServerEvents
List all the server events in the current configuration. Output is an array of objects, each representing an individual server event.
Name | Type | Description |
Id | string | The unique Id of this server event |
Name | string | The name of this server event |
curl http://{webservice}/rest/ServerEvents?sid={sid} -X GET
Status: 200 OK [ { "Id": "0", "Name": "RunAfterReportExecution" }, { "Id": "1", "Name": "AddDisclaimerToOutput" } ]
GET /rest/ServerEvents/{Id}
Show the properties of the server event specified by its Id.
curl http://{webservice}/rest/ServerEvents/{Id}?sid={sid} -X GET
Status: 200 OK { "Id": "0", "Name": "RunAfterReportExecution" }
DELETE /rest/ServerEvents/{Id}
curl http://{webservice}/rest/ServerEvents/{Id}?sid={sid} -X DELETE
Status: 204 No Content