Get a Vertex Type by ID
get
/api/graph/VertexTypes/{id}
Gets the vertex type that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The vertex type 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 : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : graphVertexTypesRead
Type:
Show Source
object
-
Source: string
The source of the icon. Allowed values:- Image, Font Awesome Icon, or Unified Assurance Icon
-
VertexTypeIcon: string
Vertex type icon. It may be a CSS clas or a path to an image.Example:
fa fa-brick
-
VertexTypeIconName: string
Vertex type icon name. It may be a CSS class or the image name with no path or file extension.Example:
brick
-
VertexTypeID: integer
Vertex Type IDExample:
1030
-
VertexTypeName: string
Vertex Type NameExample:
Device
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