Get an Element by ID
get
/api/gateway/Elements/{id}
Gets the element that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The element object ID.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 : gatewayElementsRead
Type:
Show Source
object
-
Commands: array
Commands
Poll Commands to run on network element. The order listed is the order commands will be run.
-
CTAG: string
Element CTAGExample:
ctag
-
Description: string
Description of the Element.Example:
-
ElementID: string
Unique identifier for the element.Example:
825f3a56-2697-49e1-a3e6-375dd6fe61eb
-
ElementName: string
The name of the element, which must be unique within the database.Example:
Element1
-
GatewayID: string
Parent GatewayExample:
18b88a04-5b5d-455c-bc9e-0ad28cf7aee0
-
GatewayName: string
The parent gateway for the element.Example:
Gateway1
-
LoginCommand: string
Command to login to the element.Example:
act
-
LogoutCommand: string
Command to logout of the element.Example:
canc
-
PollTimer: integer
Seconds to wait after running each poll command.Example:
30
-
TID: string
Element TIDExample:
tid
Nested Schema : Commands
Type:
array
Poll Commands to run on network element. The order listed is the order commands will be run.
Show Source
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