Server events can be accessed for reference and disabled for the session. Server events cannot currently be created or edited using REST.
Note. All requests require Session Id URL parameter and basic request headers. In the following examples, headers are omitted for clarity.
Server events are represented as JSON objects with the following properties:
Name | Type | Writeable | 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