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
  • JournalActor
  • JournalAction

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

For both types of tool, JournalActor and JournalAction are required, but if JournalStatus is set to 0 (false), you can set them to null values ("").

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Determines if all data is returned for record(Required only for Tool Type of View)
    Example: oracle.doceng.json.BetterJsonNull@66450129
  • Tool Height(Required only for Tool Type of View)
    Example: oracle.doceng.json.BetterJsonNull@14927cd4
  • Icon
    Example: fugue/thumb-up.png
  • The action value to use when the tool is run. This is always required, but if JournalStatus is set to 0 (false), you can set this to a null value ("").
    Example: Added by Event Tool
  • The actor value to use when the tool is run. This is always required, but if JournalStatus is set to 0 (false), you can set this to a null value ("").
    Example: Event Tool
  • Enable/disable journaling when tool is run
    Example: 1
  • Text to add to journal when tool is run
    Example: Event Acknowledged
  • Determines if the event list should be unpaused and refreshed when the tool finishes(Required only for Tool Type of View)
    Example: oracle.doceng.json.BetterJsonNull@2bfe4df9
  • 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
  • Relative path to view(Required only for Tool Type of View)
    Example: oracle.doceng.json.BetterJsonNull@5fc42998
  • ID of the path type (Required only for Tool Type of View) Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote
    Example: oracle.doceng.json.BetterJsonNull@f4aec23
  • This SQL command will be run against the Event.Events schema table (Required only for Tool Type of SQL)
    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);
  • Tool Target(Required only for Tool Type of View) Allowed Values: - window - currenttab - newtab
    Example: oracle.doceng.json.BetterJsonNull@3d6c7152
  • Tool Type Allowed Values: - 1 => View - 2 => SQL
    Example: 2
  • Tool Width(Required only for Tool Type of View)
    Example: oracle.doceng.json.BetterJsonNull@4e773b8a
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

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