Jump to

• Request
• Response

Update a Vertex

put

/api/graph/Vertices/{id}

Updates the vertex that matches the specified ID.

Request

Path Parameters

• id(required): string
  The vertex ID.

  Example:

  1c730895-8505-43a9-ac8e-f18c75edcde9

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• VertexName: string
  The vertex name.
  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: router.example.com
• VertexProps: array VertexProps
  Vertex Properties
• Viewers: array Viewers
  List of user groups that can view

{
    "properties":{
        "VertexName":{
            "description":"The vertex name.\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":"router.example.com"
        },
        "VertexProps":{
            "description":"Vertex Properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyName":{
                        "description":"Property Name",
                        "type":"string",
                        "example":"ZoneID"
                    },
                    "PropertyValue":{
                        "description":"Property Value",
                        "type":"integer",
                        "example":3
                    }
                }
            },
            "example":[
                {
                    "PropertyName":"ZoneID",
                    "PropertyValue":3
                }
            ]
        },
        "Viewers":{
            "description":"List of user groups that can view",
            "type":"array",
            "items":{
            },
            "example":[
            ]
        }
    },
    "type":"object"
}

Nested Schema : VertexProps

Type: array

Vertex Properties

Show Source

• Array of: object items

{
    "description":"Vertex Properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyName":{
                "description":"Property Name",
                "type":"string",
                "example":"ZoneID"
            },
            "PropertyValue":{
                "description":"Property Value",
                "type":"integer",
                "example":3
            }
        }
    },
    "example":[
        {
            "PropertyName":"ZoneID",
            "PropertyValue":3
        }
    ]
}

Example:

[
    {
        "PropertyName":"ZoneID",
        "PropertyValue":3
    }
]

Nested Schema : Viewers

Type: array

List of user groups that can view

Show Source

• Array of:

{
    "description":"List of user groups that can view",
    "type":"array",
    "items":{
    },
    "example":[
    ]
}

Nested Schema : items

Type: object

Show Source

• PropertyName: string
  Property Name

  Example: ZoneID
• PropertyValue: integer
  Property Value

  Example: 3

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "description":"Property Name",
            "type":"string",
            "example":"ZoneID"
        },
        "PropertyValue":{
            "description":"Property Value",
            "type":"integer",
            "example":3
        }
    }
}

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":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/graphVerticesRead"
                            },
                            {
                                "type":"object",
                                "properties":{
                                    "CustomName":{
                                        "type":"string",
                                        "description":"The custom name.",
                                        "example":"Name"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    ]
}

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":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/graphVerticesRead"
                    },
                    {
                        "type":"object",
                        "properties":{
                            "CustomName":{
                                "type":"string",
                                "description":"The custom name.",
                                "example":"Name"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/graphVerticesRead"
            },
            {
                "type":"object",
                "properties":{
                    "CustomName":{
                        "type":"string",
                        "description":"The custom name.",
                        "example":"Name"
                    }
                }
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object graphVerticesRead
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/graphVerticesRead"
        },
        {
            "type":"object",
            "properties":{
                "CustomName":{
                    "type":"string",
                    "description":"The custom name.",
                    "example":"Name"
                }
            }
        }
    ]
}

Nested Schema : graphVerticesRead

Type: object

Show Source

• TimeStampModified: integer
  Timestamp Modified

  Example: 1692270015000
• TimeStampModifiedString: string
  Timestamp Modified string

  Example: 2023-08-17T06:00:15.000Z
• VertexID: string
  Vertex ID

  Example: ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb
• VertexName: string
  Vertex Name

  Example: router.example.com
• VertexProps: array VertexProps
  Vertex properties
• VertexTypeID: integer
  Vertex type ID

  Example: 1
• VertexTypeName: string
  Vertex Type Name

  Example: Device

{
    "properties":{
        "VertexProps":{
            "description":"Vertex properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyName":{
                        "description":"Property Name",
                        "type":"string",
                        "example":"ZoneID"
                    },
                    "PropertyValue":{
                        "description":"Property Value",
                        "example":3
                    }
                }
            },
            "example":[
                {
                    "PropertyName":"ZoneID",
                    "PropertyValue":3
                }
            ]
        },
        "VertexTypeID":{
            "description":"Vertex type ID",
            "type":"integer",
            "example":1
        },
        "VertexTypeName":{
            "description":"Vertex Type Name",
            "type":"string",
            "example":"Device"
        },
        "VertexID":{
            "description":"Vertex ID",
            "type":"string",
            "example":"ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb"
        },
        "TimeStampModified":{
            "description":"Timestamp Modified",
            "type":"integer",
            "example":"1692270015000"
        },
        "TimeStampModifiedString":{
            "description":"Timestamp Modified string",
            "type":"string",
            "example":"2023-08-17T06:00:15.000Z"
        },
        "VertexName":{
            "description":"Vertex Name",
            "type":"string",
            "example":"router.example.com"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• CustomName: string
  The custom name.

  Example: Name

{
    "type":"object",
    "properties":{
        "CustomName":{
            "type":"string",
            "description":"The custom name.",
            "example":"Name"
        }
    }
}

Nested Schema : VertexProps

Type: array

Vertex properties

Show Source

• Array of: object items

{
    "description":"Vertex properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyName":{
                "description":"Property Name",
                "type":"string",
                "example":"ZoneID"
            },
            "PropertyValue":{
                "description":"Property Value",
                "example":3
            }
        }
    },
    "example":[
        {
            "PropertyName":"ZoneID",
            "PropertyValue":3
        }
    ]
}

Example:

[
    {
        "PropertyName":"ZoneID",
        "PropertyValue":3
    }
]

Nested Schema : items

Type: object

Show Source

• PropertyName: string
  Property Name

  Example: ZoneID
• PropertyValue:
  Property Value

  Example: 3

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "description":"Property Name",
            "type":"string",
            "example":"ZoneID"
        },
        "PropertyValue":{
            "description":"Property Value",
            "example":3
        }
    }
}

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