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
-
filter: object
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.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
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
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
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"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
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 list of event tools that match the specified parameters.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The list of event tools that match the specified parameters.
Show Source
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