Get an Edge by ID
get
/api/graph/Edges/{id}
Gets the edge that matches the specified ID.
Request
Path Parameters
-
id(required): string
The edge ID.
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 : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : graphEdgesRead
Type:
Show Source
object
-
EdgeID: string
Edge IDExample:
4a611c07-d077-4438-a0b3-d42e7ff488ad_18b88a04-5b5d-455c-bc9e-0ad28cf7aee0_825f3a56-2697-49e1-a3e6-375dd6fe61eb
-
EdgeProps: array
EdgeProps
Edge Properties
-
EdgeTypeID: integer
Edge Type IDExample:
7
-
EdgeTypeName: string
Edge Type NameExample:
HasTL1Element
-
InVertexCustomName: string
Target Vertex Custom NameExample:
-
InVertexID: string
Target Vertex IDExample:
825f3a56-2697-49e1-a3e6-375dd6fe61eb
-
InVertexName: string
Target Vertex NameExample:
Element1
-
OutVertexCustomName: string
Source Vertex Custom NameExample:
-
OutVertexID: string
Source Vertex IDExample:
18b88a04-5b5d-455c-bc9e-0ad28cf7aee0
-
OutVertexName: string
Source Vertex NameExample:
Gateway1
-
TimestampModified: integer
Time Stamp ModifiedExample:
1.692196209706E12
-
TimestampModifiedString: string
Time Stamp Modified StringExample:
2023-08-16 09:30:09
Nested Schema : EdgeProps
Type:
array
Edge Properties
Show Source
Example:
[
{
"PropertyName":"EdgeActiveType",
"PropertyValue":"Metric"
}
]
Nested Schema : items
Type:
Show Source
object
-
PropertyName: string
The property name.Example:
EdgeActiveType
-
PropertyValue: string
The property value.Example:
Metric
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