Get an Edge Type by ID
get
/api/graph/EdgeTypes/{id}
Gets the edge type that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The edge type ID.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
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 : graphEdgeTypesRead
Type:
Show Source
object
-
Direction: string
Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips. Allowed Values: - Non-Directional - DirectionalExample:
Non-Directed
-
EdgeTypeID: integer
Edge Type IDExample:
3
-
EdgeTypeName: string
Edge Type NameExample:
ConnectsInterface
-
LineStyle: string
Line Style Allowed Values - Solid - Dashed - DottedExample:
Solid
-
LineTypeID: integer
Line Type ID - 0 => Solid - 1 => Dashed - 2 => DottedExample:
0
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.