REST API for Unified Assurance Core

Update an Event Tool

put

/api/event/Tools/{id}

Updates the properties of the event tool that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The event tool ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AugmentData: boolean

Determines if all data is returned for record(Required only for Tool Type of View)

Example: oracle.doceng.json.BetterJsonNull@66450129
Height: integer

Tool Height(Required only for Tool Type of View)

Example: oracle.doceng.json.BetterJsonNull@14927cd4
Icon: string

Icon

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

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
JournalActor: string

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
JournalStatus: integer

Enable/disable journaling when tool is run

Example: 1
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(Required only for Tool Type of View)

Example: oracle.doceng.json.BetterJsonNull@2bfe4df9
ToolName: string

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
ToolPath: string

Relative path to view(Required only for Tool Type of View)

Example: oracle.doceng.json.BetterJsonNull@5fc42998
ToolPathTypeID: integer

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
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 - newtab

Example: oracle.doceng.json.BetterJsonNull@3d6c7152
ToolTypeID: integer

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

Example: 2
Width: integer

Tool Width(Required only for Tool Type of View)

Example: oracle.doceng.json.BetterJsonNull@4e773b8a

{
    "type":"object",
    "properties":{
        "ToolName":{
            "description":"The event tool name.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Acknowledge"
        },
        "ToolTypeID":{
            "$ref":"#/components/schemas/eventToolsRead/properties/ToolTypeID"
        },
        "ToolPath":{
            "description":"Relative path to view(Required only for Tool Type of View)",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ToolPathTypeID":{
            "description":"ID of the path type\n(Required only for Tool Type of View)\nAllowed Values:\n-  1 => Local\n-  2 => Internal\n-  3 => Hybrid\n-  4 => Remote",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "AugmentData":{
            "description":"Determines if all data is returned for record(Required only for Tool Type of View)",
            "type":"boolean",
            "example":null,
            "nullable":true
        },
        "Refresh":{
            "description":"Determines if the event list should be unpaused and refreshed when the tool finishes(Required only for Tool Type of View)",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "ToolTarget":{
            "description":"Tool Target(Required only for Tool Type of View)\n\nAllowed Values:\n-  window\n-  currenttab\n-  newtab",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Width":{
            "description":"Tool Width(Required only for Tool Type of View)",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "Height":{
            "description":"Tool Height(Required only for Tool Type of View)",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "ToolSQL":{
            "description":"This SQL command will be run against the Event.Events schema table (Required only for Tool Type of SQL)",
            "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);"
        },
        "Icon":{
            "$ref":"#/components/schemas/eventToolsRead/properties/Icon"
        },
        "JournalStatus":{
            "$ref":"#/components/schemas/eventToolsRead/properties/JournalStatus"
        },
        "JournalText":{
            "$ref":"#/components/schemas/eventToolsRead/properties/JournalText"
        },
        "JournalActor":{
            "description":"The actor value to use when the tool is run. This is always required, but if <b>JournalStatus</b> is set to <b>0</b> (false), you can set this to a null value (<b>\"\"</b>).",
            "type":"string",
            "example":"Event Tool"
        },
        "JournalAction":{
            "description":"The action value to use when the tool is run. This is always required, but if <b>JournalStatus</b> is set to <b>0</b> (false), you can set this to a null value (<b>\"\"</b>).",
            "type":"string",
            "example":"Added by Event Tool"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation

The response body for a successful update operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventToolsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

message: string

The response message.

Example: Updated record
success: boolean

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

Example: true

{
    "description":"The response body for a successful update 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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventToolsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object eventToolsRead

{
    "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.