REST API for Unified Topology for Inventory and Automation

Retrieve All Vertices

get

/vertex

Return All Vertices

Request

Query Parameters

id: string

The vertex id to be searched
label: array

The vertex labels to be searched
name: string

The vertex properties to be searched
property(required): array

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Vertices retrieved successfully

Root Schema : schema

Type: object

Show Source

activeEvent: integer (int64)
activeEventDesc: string
area: string
autoSuggestName: string
availablePositions: string
businessObjectClass: string
category: string
circle: string
city: string
communication: integer (int64)
country: string
createdDate: string (date)
createdUser: string
deviceIdentifier: string
district: string
entityId: integer (int64)
entityVersion: integer (int32)
equipmentCategory: string
fromNodeSubNetwork: integer (int64)
id: string
inventoryStatus: string
ipv4: string
ipv4Subnet: string
ipv6: string
ipv6Subnet: string
lastModifiedDate: string (date)
lastModifiedUser: string
latitude: number (double)
locationCode: string
longitude: number (double)
macAddress: string
name: string
networkStatus: string
nodeCategory: string
nodeType: string
occupiedPositions: string
operator: string
postalCode: string
properties: object properties

Additional Properties Allowed: additionalProperties
province: string
referenceId: integer (int64)
region: string
relationships: object relationships

Additional Properties Allowed: additionalProperties
specName: string
state: string
subCategory: string
subNetworkEntityId: integer (int64)
subNetworkName: string
subType: string
toNodeSubNetwork: integer (int64)
topologyType: string
zoneId: string

{
    "properties":{
        "activeEvent":{
            "format":"int64",
            "type":"integer"
        },
        "area":{
            "type":"string"
        },
        "autoSuggestName":{
            "type":"string"
        },
        "availablePositions":{
            "type":"string"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "circle":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "communication":{
            "format":"int64",
            "type":"integer"
        },
        "country":{
            "type":"string"
        },
        "createdDate":{
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "deviceIdentifier":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "equipmentCategory":{
            "type":"string"
        },
        "fromNodeSubNetwork":{
            "format":"int64",
            "type":"integer"
        },
        "id":{
            "type":"string"
        },
        "inventoryStatus":{
            "type":"string"
        },
        "ipv4":{
            "type":"string"
        },
        "ipv4Subnet":{
            "type":"string"
        },
        "ipv6":{
            "type":"string"
        },
        "ipv6Subnet":{
            "type":"string"
        },
        "lastModifiedDate":{
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "latitude":{
            "format":"double",
            "type":"number"
        },
        "locationCode":{
            "type":"string"
        },
        "longitude":{
            "format":"double",
            "type":"number"
        },
        "macAddress":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "networkStatus":{
            "type":"string"
        },
        "nodeCategory":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "occupiedPositions":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "province":{
            "type":"string"
        },
        "referenceId":{
            "format":"int64",
            "type":"integer"
        },
        "region":{
            "type":"string"
        },
        "relationships":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "specName":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "subCategory":{
            "type":"string"
        },
        "subNetworkEntityId":{
            "format":"int64",
            "type":"integer"
        },
        "subNetworkName":{
            "type":"string"
        },
        "subType":{
            "type":"string"
        },
        "toNodeSubNetwork":{
            "format":"int64",
            "type":"integer"
        },
        "topologyType":{
            "type":"string"
        },
        "zoneId":{
            "type":"string"
        },
        "activeEventDesc":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Nested Schema : relationships

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Examples

400 Response

The request isn't valid

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

The request is unauthorized

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

403 Response

The request is forbidden

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

404 Response

The requested resource not found

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

500 Response

An Internal Server Error has occurred

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}