1. REST API for Unified Assurance Core
  2. Tasks
  3. Events
  4. Event Tools

Get Event Tools

get

/api/event/Tools/

Gets the event tools that match the specified parameters. If no parameters are specified, all event tools are returned.

Request

Query Parameters
  • The fields to filter the results by. You cannot filter by fields that contain a state.
    This parameter's value uses the following JSON format:
    { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
    If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • Default Value: LIKE
      Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
      The filter operation to use.
      Example: eq
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The field and direction to sort results by. You cannot sort by fields that contain a state.
    This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The list of event tools that match the specified parameters.
Show Source
Nested Schema : eventToolsRead
Type: object
Show Source
  • Whether to obtain event data for the selected event (1) or not (0) to be used in the tool's request parameters. Only used for view tools.
    Example: 1
  • The height of the tool window, in pixels. Only used for view tools.
    Example: 80
  • The icon to represent the tool.
    Example: fugue/thumb-up.png
  • The action that will be used when adding an event journal when the event tool is run. If not specified, defaults to the name of the event tool.
    Example: Added by Event Tool
  • The actor that will be used when adding an event journal when the event tool is run. If not specified, defaults to the user who ran the tool.
    Example: operator
  • The integer indication of whether an event journal entry will be added when tool is run (1) or not (0).
    Example: 1
  • The icon to indicate the journal status.
    Example: OrbGreen.png
  • The text indication of whether a journal entry is added when the tool is run (Enabled) or not (Disabled).
    Example: Enabled
  • The event journal entry that will be added when the tool is run.
    Example: Event Acknowledged
  • Whether the event list should be unpaused and refreshed when the tool finishes (1) or not (0). Only used for view tools. When ToolTarget is set to newtab, the list refreshes when the tab opens.
    When ToolTarget is set to window, the list refreshes when the pop-up window is closed.
    When ToolTarget is set to currenttab, this setting does not apply.
    Example: 1
  • The event tool ID.
    Example: 1
  • The event tool name.
    Example: Acknowledge
  • The relative path to the URL that the tool opens. Only used for view tools.
    Example: /go/vision/index?filterText=<Details>
  • The tool path type. Only used for view tools.
    Allowed values are:
  • Local
  • Internal
    • Hybrid
    • Remote
Example: Remote
  • The tool path type ID. Only used for view tools.
    Allowed values:
    • 1: Local
    • 2: Internal
    • 3: Hybrid
    • 4: Remote
    Example: oracle.doceng.json.BetterJsonNull@402adc9c
  • The SQL command to run against the Event.Events schema table. Only used for SQL tools.
    Example: UPDATE Events SET Action = 'SQL Tool: Acknowledge', Actor = $USERNAME, LastChanged = UNIX_TIMESTAMP(NOW(3)), Ack = 1, OwnerName = $USERNAME WHERE Ack = 0 AND EventID IN ($EVENTLIST);
  • Where the tool opens new pages. Only used for view tools.
    Allowed values:
    • window: Opens in a pop-up window.
    • currenttab: Opens in the current tab.
    • newtab: Opens in a new tab.
    Example: window
  • The display name to use for the ToolTarget setting. Only used for view tools.
    Allowed Values:
    • PopUp
    • CurrentTab
    • NewTab
    Example: PopUp
  • The ID of the event tool type. Allowed values:
    • 1: View
    • 2: SQL
    Example: 1
  • The name of the event tool type. Allowed values:
    • View
    • SQL
    Example: View
  • The width of the tool window, in pixels. Only used for view tools.
    Example: 80

    • Default Response

    Failed operation
    Body ()
    Root Schema : schema
    Type: object
    Show Source
    Nested Schema : errors
    Type: array
    The list of errors reported. Validation errors will be keyed by record field.
    Show Source
    Nested Schema : items
    Type: object
    An error.
    Back to Top