Create a Vertex
post
/api/graph/Vertices
Creates a new vertex.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
VertexName: string
Vertex NameExample:
router.example.com
-
VertexProps: array
VertexProps
Vertex Properties
-
VertexTypeID: integer
Vertex Type IDExample:
1
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : VertexProps
Type:
array
Vertex Properties
Show Source
Example:
[
{
"PropertyName":"ZoneID",
"PropertyValue":3
}
]
Nested Schema : items
Type:
Show Source
object
-
PropertyName: string
Property NameExample:
ZoneID
-
PropertyValue: integer
Property ValueExample:
3
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
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 : graphVerticesRead
Type:
Show Source
object
-
TimeStampModified: integer
Timestamp ModifiedExample:
1.692270015E12
-
TimeStampModifiedString: string
Timestamp Modified stringExample:
2023-08-17T06:00:15.000Z
-
VertexID: string
Vertex IDExample:
ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb
-
VertexName: string
Vertex NameExample:
router.example.com
-
VertexProps: array
VertexProps
Vertex properties
-
VertexTypeID: integer
Vertex type IDExample:
1
-
VertexTypeName: string
Vertex Type NameExample:
Device
Nested Schema : type
Type:
Show Source
object
-
CustomName: string
The custom name.Example:
VertexName
Nested Schema : VertexProps
Type:
array
Vertex properties
Show Source
Example:
[
{
"PropertyName":"ZoneID",
"PropertyValue":3
}
]
Nested Schema : items
Type:
Show Source
object
-
PropertyName: string
Property NameExample:
ZoneID
-
PropertyValue:
Property ValueExample:
3
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