REST API for Unified Assurance Core

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.

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

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
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

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
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.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of event tools that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventToolsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of event tools that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventToolsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of event tools that match the specified parameters.

Show Source

Array of: object eventToolsRead

{
    "description":"The list of event tools that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventToolsRead"
    }
}

Nested Schema : eventToolsRead

Type: object

Show Source

AugmentData: boolean

Determines if all data is returned for record

Example: oracle.doceng.json.BetterJsonNull@66297b63
Height: integer

Height of the tool window in pixels

Example: oracle.doceng.json.BetterJsonNull@106387cf
Icon: string

Icon

Example: fugue/thumb-up.png
JournalAction: string

The action that ran the tool.

Example: Added by Event Tool
JournalActor: string

The actor that ran the tool.

Example: Event Tool
JournalStatus: integer

Enable/disable journaling when tool is run

Example: 1
JournalStatusIcon: string

Journal Status Icon

Example: OrbGreen.png
JournalStatusName: string

Journal status if enabled/disabled

Example: Enabled
JournalText: string

Text to add to journal when tool is run

Example: Event Acknowledged
Refresh: integer

Determines if the event list should be unpaused and refreshed when the tool finishes

Example: oracle.doceng.json.BetterJsonNull@535adf36
ToolID: integer

The event tool ID.

Example: 1
ToolName: string

Tool Name

Example: Acknowledge
ToolPath: string

Relative path to view

Example: oracle.doceng.json.BetterJsonNull@79f82fc4
ToolPathType: string

Tool Path type Allowed values: - Hybrid - Internal - Local - Remote

Example: oracle.doceng.json.BetterJsonNull@4fe4b8b6
ToolPathTypeID: string

Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

Example: oracle.doceng.json.BetterJsonNull@63767d
ToolSQL: string

This SQL command will be run against the Event.Events schema table

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 Allowed Values: - window - currenttab - newtab

Example: oracle.doceng.json.BetterJsonNull@2d21d12b
ToolTargetDisplay: string

Tool target display Allowed Values: - PopUp - CurrentTab - NewTab

Example: oracle.doceng.json.BetterJsonNull@27f8f1cc
ToolTypeID: integer

Tool Type Allowed Values: - 1 => View - 2 => SQL

Example: 2
ToolTypeName: string

Tool type name

Example: SQL
Width: integer

Width of the tool window in pixels

Example: oracle.doceng.json.BetterJsonNull@623c9988

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"The event tool ID.",
            "type":"integer",
            "example":"1"
        },
        "ToolName":{
            "description":"Tool Name",
            "type":"string",
            "example":"Acknowledge"
        },
        "ToolTypeID":{
            "description":"Tool Type\n\nAllowed Values:\n-  1 => View\n-  2 => SQL",
            "type":"integer",
            "example":"2"
        },
        "ToolTypeName":{
            "description":"Tool type name",
            "type":"string",
            "example":"SQL"
        },
        "JournalStatusName":{
            "description":"Journal status if enabled/disabled",
            "type":"string",
            "example":"Enabled"
        },
        "JournalStatusIcon":{
            "description":"Journal Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Icon":{
            "description":"Icon",
            "type":"string",
            "example":"fugue/thumb-up.png"
        },
        "JournalStatus":{
            "description":"Enable/disable journaling when tool is run",
            "type":"integer",
            "example":"1"
        },
        "JournalText":{
            "description":"Text to add to journal when tool is run",
            "type":"string",
            "example":"Event Acknowledged"
        },
        "ToolPath":{
            "description":"Relative path to view",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ToolPathType":{
            "description":"Tool Path type\n\nAllowed values:\n- Hybrid\n- Internal\n- Local\n- Remote",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "AugmentData":{
            "description":"Determines if all data is returned for record",
            "type":"boolean",
            "example":null,
            "nullable":true
        },
        "Refresh":{
            "description":"Determines if the event list should be unpaused and refreshed when the tool finishes",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "Width":{
            "description":"Width of the tool window in pixels",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "Height":{
            "description":"Height of the tool window in pixels",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "ToolTarget":{
            "description":"Tool Target\n\nAllowed Values:\n-  window\n-  currenttab\n-  newtab",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ToolTargetDisplay":{
            "description":"Tool target display\n\nAllowed Values:\n-  PopUp\n-  CurrentTab\n-  NewTab",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ToolPathTypeID":{
            "description":"Tool Path Type\n\nAllowed Values:\n-  1 => Local\n-  2 => Internal\n-  3 => Hybrid\n-  4 => Remote",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ToolSQL":{
            "description":"This SQL command will be run against the Event.Events schema table",
            "type":"string",
            "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);"
        },
        "JournalActor":{
            "description":"The actor that ran the tool.",
            "type":"string",
            "example":"Event Tool"
        },
        "JournalAction":{
            "description":"The action that ran the tool.",
            "type":"string",
            "example":"Added by Event Tool"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.