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

Create an Event Tool

post

/api/event/Tools/

Creates a new event tool.
When ToolTypeID is 1 (for View tools), the minimum required properties in the request body are:
  • ToolName
  • Icon
  • ToolPath
  • ToolPathTypeID
  • ToolTarget
  • Refresh
  • AugmentData
  • ToolTypeID

When ToolTypeID is 2 (for SQL tools), the minimum required properties in the request body are:
  • ToolName
  • ToolTypeID
  • Icon

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
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. 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 to use 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 to use when adding an event journal when the event tool is run. If not specified, defaults to the user who ran the tool.
    Example: Event Tool
  • Whether to add an event journal entry when tool is run (1) or not (0).
    Example: 1
  • The event journal entry to add 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 name.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    Example: Acknowledge
  • The relative path to the URL that the tool opens. Required for view tools only.
    You can use tokens in the path that will be replaced with data from the selected event when the tool is run. The tokens are in the format <Field> or, for fields using display conversions, <FieldRaw>.
    For example, if you have a display conversion for ZoneID, use <ZoneIDRaw> for the token.
    If you later disable the conversion, you do not have to update the tool path again. The path will still work with the Raw field name, even when the conversion is disabled. If you delete the conversion, you must update the path to remove Raw. See the api/event/displayConversions endpoints for more information about creating display conversions.
    You can use the following additional tokens:
    • <EventID>: The first selected event's EventID.
    • <Events>: A comma-delimited list of all selected EventIDs.
    • <ShardID>: The first selected event's ShardID.
    • <Shards>: A comma-delimited list of all selected events' ShardIDs.
    Example: /go/vision/index?filterText=&lt;Details&gt;
  • 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@5e89e527
  • 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 ID of the event tool type. Allowed values:
    • 1: View
    • 2: SQL
    Example: 1
  • The width of the tool window, in pixels. Only used for view tools.
    Example: 80
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
The response body for a successful add operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The properties of the new event tool.
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=&lt;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