Update a Tool
put
/api/topology/Tools/{id}
Updates the properties of an existing topology tool specified by the tool ID.
Request
Path Parameters
-
id(required): integer(int32)
The tool ID.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Height: integer
Height in pixels if tool target is window.Example:
80
-
Icon: string
Tool icon for menu displayExample:
fugue/heart--exclamation.png
-
ToolName: string
Tool NameExample:
Device Overview
-
ToolPath: string
Relative path to viewExample:
dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
-
ToolPathTypeID: integer
Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
2
-
ToolTarget: string
Tool Target Allowed Values: - window - currenttab - newtabExample:
window
-
ToolTypeID: integer
Tool Type Allowed Values: - 1 => ViewExample:
1
-
Width: integer
Width in pixels if tool target is window.Example:
80
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated 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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : topologyToolsRead
Type:
Show Source
object
-
Height: integer
Height in pixels if tool target is window.Example:
80
-
Icon: string
Tool icon for menu displayExample:
fugue/heart--exclamation.png
-
ObjectTypeID: integer
Object Type IDExample:
1
-
ToolID: integer
Tool IDExample:
1
-
ToolName: string
Tool NameExample:
Device Overview
-
ToolPath: string
Relative path to viewExample:
dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
-
ToolPathTypeID: integer
Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
2
-
ToolPathTypeName: string
Tool Path Type NameExample:
Internal
-
ToolTarget: string
Tool Target Allowed Values: - window - currenttab - newtabExample:
window
-
ToolTargetName: string
Tool Target NameExample:
window
-
ToolTypeID: integer
Tool Type Allowed Values: - 1 => ViewExample:
1
-
ToolTypeName: string
Tool Type NameExample:
View
-
Width: integer
Width in pixels if tool target is window.Example:
80
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