Scroll

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.

Note. All requests require Session Id URL parameter and basic request headers. In the following examples, headers are omitted for clarity.

Server Event JSON

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.

Example

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

List Server Events

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

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

GET /rest/serverevents/{Id}

Show the properties of the server event specified by its 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

Hidden Article Information

Article Author
Exago Development
created 2017-02-21 17:25:39 UTC
updated 2017-04-05 21:01:19 UTC

Labels
REST, API, Web Service, ServerEvents,
Have more questions? Submit a request