Create an Event Tool
post
/api/event/Tools/
Creates a new event tool.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AugmentData: boolean
Determines if all data is returned for record(Required only for Tool Type of View)Example:
oracle.doceng.json.BetterJsonNull@259ae1a9
-
Height: integer
Tool Height(Required only for Tool Type of View)Example:
oracle.doceng.json.BetterJsonNull@6ddc9001
-
Icon: string
IconExample:
fugue/thumb-up.png
-
JournalStatus: integer
Enable/disable journaling when tool is runExample:
1
-
JournalText: string
Text to add to journal when tool is runExample:
Event Acknowledged
-
Refresh: integer
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@510e0dd2
-
ToolName: string
Tool NameExample:
Acknowledge
-
ToolPath: string
Relative path to view(Required only for Tool Type of View)Example:
oracle.doceng.json.BetterJsonNull@153cf928
-
ToolPathTypeID: integer
ID of the path type (Required only for Tool Type of View) Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
oracle.doceng.json.BetterJsonNull@66ad7167
-
ToolSQL: string
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);
-
ToolTarget: string
Tool Target(Required only for Tool Type of View) Allowed Values: - window - currenttab - newtabExample:
oracle.doceng.json.BetterJsonNull@3b235623
-
ToolTypeID: integer
Tool Type Allowed Values: - 1 => View - 2 => SQLExample:
2
-
Width: integer
Tool Width(Required only for Tool Type of View)Example:
oracle.doceng.json.BetterJsonNull@15c8b75c
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new event tool.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventToolsRead
Type:
Show Source
object
-
AugmentData: boolean
Determines if all data is returned for recordExample:
oracle.doceng.json.BetterJsonNull@65a01901
-
Height: integer
Height of the tool window in pixelsExample:
oracle.doceng.json.BetterJsonNull@51a73873
-
Icon: string
IconExample:
fugue/thumb-up.png
-
JournalStatus: integer
Enable/disable journaling when tool is runExample:
1
-
JournalStatusIcon: string
Journal Status IconExample:
OrbGreen.png
-
JournalStatusName: string
Journal status if enabled/disabledExample:
Enabled
-
JournalText: string
Text to add to journal when tool is runExample:
Event Acknowledged
-
Refresh: integer
Determines if the event list should be unpaused and refreshed when the tool finishesExample:
oracle.doceng.json.BetterJsonNull@597eb9ac
-
ToolID: integer
The event tool ID.Example:
1
-
ToolName: string
Tool NameExample:
Acknowledge
-
ToolPath: string
Relative path to viewExample:
oracle.doceng.json.BetterJsonNull@3aac31b7
-
ToolPathType: string
Tool Path type Allowed values: - Hybrid - Internal - Local - RemoteExample:
oracle.doceng.json.BetterJsonNull@a1be5cb
-
ToolPathTypeID: string
Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
oracle.doceng.json.BetterJsonNull@4f239a76
-
ToolSQL: string
This SQL command will be run against the Event.Events schema tableExample:
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);
-
ToolTarget: string
Tool Target Allowed Values: - window - currenttab - newtabExample:
oracle.doceng.json.BetterJsonNull@48b1b469
-
ToolTargetDisplay: string
Tool target display Allowed Values: - PopUp - CurrentTab - NewTabExample:
oracle.doceng.json.BetterJsonNull@27ada0e8
-
ToolTypeID: integer
Tool Type Allowed Values: - 1 => View - 2 => SQLExample:
2
-
ToolTypeName: string
Tool type nameExample:
SQL
-
Width: integer
Width of the tool window in pixelsExample:
oracle.doceng.json.BetterJsonNull@5b8ba1d2
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
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