Jump to

• Request
• Response

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

Request Body - 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@259ae1a9
• Height: integer
  Tool Height(Required only for Tool Type of View)

  Example: oracle.doceng.json.BetterJsonNull@6ddc9001
• Icon: string
  Icon

  Example: fugue/thumb-up.png
• 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@510e0dd2
• ToolName: string
  Tool Name

  Example: 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 => Remote

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

  Example: oracle.doceng.json.BetterJsonNull@3b235623
• 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@15c8b75c

{
    "type":"object",
    "properties":{
        "ToolName":{
            "$ref":"#/components/schemas/eventToolsRead/properties/ToolName"
        },
        "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

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

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new event tool.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new event tool.",
            "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

The properties of the new event tool.

Show Source

• Array of: object eventToolsRead

{
    "description":"The properties of the new event tool.",
    "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@65a01901
• Height: integer
  Height of the tool window in pixels

  Example: oracle.doceng.json.BetterJsonNull@51a73873
• Icon: string
  Icon

  Example: fugue/thumb-up.png
• 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@597eb9ac
• 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@3aac31b7
• ToolPathType: string
  Tool Path type Allowed values: - Hybrid - Internal - Local - Remote

  Example: oracle.doceng.json.BetterJsonNull@a1be5cb
• ToolPathTypeID: string
  Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

  Example: oracle.doceng.json.BetterJsonNull@4f239a76
• 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@48b1b469
• ToolTargetDisplay: string
  Tool target display Allowed Values: - PopUp - CurrentTab - NewTab

  Example: oracle.doceng.json.BetterJsonNull@27ada0e8
• 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@5b8ba1d2

{
    "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);"
        }
    }
}

Default Response

Failed operation

Body ()

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

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

Nested Schema : items

Type: object

Back to Top