Jump to

• Request
• Response

Update a Vertex Type

put

/api/graph/VertexTypes/{id}

Updates the vertex type that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The vertex type ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "VertexTypeName":{
            "description":"The vertex type name. The name may not contain spaces, commas, or backticks.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Device"
        },
        "VertexTypeIcon":{
            "description":"Vertex type icon. It may be a CSS clas or a path to an image.",
            "type":"string",
            "example":"fa fa-brick"
        },
        "Source":{
            "description":"The source of the icon. Allowed values:- Image, Font Awesome Icon, or Unified Assurance Icon",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/graphVertexTypesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/graphVertexTypesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object graphVertexTypesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/graphVertexTypesRead"
    }
}

Nested Schema : graphVertexTypesRead

Type: object

Show Source

• 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 ID

  Example: 1030
• VertexTypeName: string
  Vertex Type Name

  Example: Device

{
    "properties":{
        "VertexTypeID":{
            "description":"Vertex Type ID",
            "type":"integer",
            "example":1030
        },
        "VertexTypeName":{
            "description":"Vertex Type Name",
            "type":"string",
            "example":"Device"
        },
        "VertexTypeIcon":{
            "description":"Vertex type icon. It may be a CSS clas or a path to an image.",
            "type":"string",
            "example":"fa fa-brick"
        },
        "VertexTypeIconName":{
            "description":"Vertex type icon name. It may be a CSS class or the image name with no path or file extension.",
            "type":"string",
            "example":"brick"
        },
        "Source":{
            "description":"The source of the icon. Allowed values:- Image, Font Awesome Icon, or Unified Assurance Icon",
            "type":"string"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

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.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top