Create a Vertex Type
post
/api/graph/VertexTypes
Creates a new vertex type.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- VertexTypeName
- Source
- VertexTypeIcon
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
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
-
VertexTypeName: string
The vertex type name. The name may not contain spaces, commas, or backticks.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:Device
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:
object
The 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 : 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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.