Create an Edge Type
post
/api/graph/EdgeTypes
Creates an edge type.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- EdgeTypeName
- LineTypeID
- Direction
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
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 -
EdgeTypeName: string
The edge type name. The name may not contain spaces, commas, or backticks.Example:
ConnectsInterface -
LineTypeID: integer
Line Type ID - 0 => Solid - 1 => Dashed - 2 => DottedExample:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
objectThe response body for a successful add operation.
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
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:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.