Description
This function gets all of the key names that are used in event data in histories that match a filter.
Parameters
| Name | Type | Description |
|---|---|---|
| datasource | String, optional | The name of the datasource from where histories will be retrieved. This parameter overrides the same parameter in the worker configuration which in turn overrides the default datasource |
| filter | Filter-object, optional | The filter specifies which histories will be inspected. The syntax of filter objects relates to many methods and is explained in Filter Objects |
| sealed | Boolean | If sealed is true, then only histories that have been switched into read-only mode will be searched. If sealed is false then only writable histories will be searched. If sealed is not supplied, then all histories will be searched |
| getsql | Boolean, optional | If this parameter is supplied and set to true then the return structure will include an element called "sql" which contains the query and the parameters which were used to retrieve the history data from the database. This option returns a large amount of data and is intended for testing and debugging |
Returns
If the getEventKeys() operation was successful then the "result" structure will contain an array of strings. Each string is the fully qualified key of a field that appears in event data in at least one of the histories that match the filter.
Example
"method": "getEventKeys",
"params": {
"filter" : {"key":"labela", "EQ":"Disruption"}
} "result": [
"status.code",
"status.text",
"reason",
"notes[0]",
"notes[1]",
"notes[2]"
]
Last modified on June 27, 2023
Share this page
