REST API for Unified Assurance Vision

Create Multiple Entities

post

/vision/api/entities/import

Creates multiple entities.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

Admin
Api

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object schema

The entity details.

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

Nested Schema : schema

Type: object

The entity details.

Show Source

address: string

The entity address.

Example: 2300 Oracle Way, Austin, TX 78741
id: integer (int64)

The entity ID.

Example: 123
ipAddress: string

The entity IPv4 address.

Example: 192.0.2.1
ipV6Address: string

The entity IPv6 address.

Example: 2001:db8:3333:4444:5555:6666:7777:8888
lat: number (double)

The entity latitude.

Example: 30.243128396829135
lng: number (double)

The entity longitude.

Example: -97.72173882639726
metaData: object metaData

Additional Properties Allowed: additionalProperties

Metadata for the entity.
name: string

The entity name.

Example: entity123
useInDashboard: boolean

Whether the entity can be used as a site for links in dashboards (true) or not (false).

Example: true
zoneId: integer (int64)

The entity zone ID.

Example: 1

{
    "properties":{
        "address":{
            "description":"The entity address.",
            "example":"2300 Oracle Way, Austin, TX 78741",
            "type":"string"
        },
        "id":{
            "description":"The entity ID.",
            "example":123,
            "format":"int64",
            "type":"integer"
        },
        "ipAddress":{
            "description":"The entity IPv4 address.",
            "example":"192.0.2.1",
            "type":"string"
        },
        "ipV6Address":{
            "description":"The entity IPv6 address.",
            "example":"2001:db8:3333:4444:5555:6666:7777:8888",
            "type":"string"
        },
        "lat":{
            "description":"The entity latitude.",
            "example":30.243128396829135,
            "format":"double",
            "type":"number"
        },
        "lng":{
            "description":"The entity longitude.",
            "example":-97.72173882639726,
            "format":"double",
            "type":"number"
        },
        "metaData":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"Metadata for the entity.",
            "example":"type: dDevice",
            "type":"object"
        },
        "name":{
            "description":"The entity name.",
            "example":"entity123",
            "type":"string"
        },
        "useInDashboard":{
            "description":"Whether the entity can be used as a site for links in dashboards (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "zoneId":{
            "description":"The entity zone ID.",
            "example":1,
            "format":"int64",
            "type":"integer"
        }
    },
    "description":"The entity details.",
    "type":"object"
}

Nested Schema : metaData

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"Metadata for the entity.",
    "example":"type: dDevice",
    "type":"object"
}

Metadata for the entity.

Example:

type: dDevice

Nested Schema : additionalProperties

Type: object

Response

Supported Media Types

application/json

200 Response

Root Schema : SuccessResponse

Type: object

The success response details.

Show Source

csrfToken: string

The security token to prevent cross-site request forgery (CSRF).

Example: 12345
message: string

The response message.

Example: The entities were added successfully.
reason: string

The reason phrase for the response.

Example: OK
status: integer (int32)

The response status code.

Example: 200

{
    "properties":{
        "csrfToken":{
            "description":"The security token to prevent cross-site request forgery (CSRF).",
            "example":"12345",
            "type":"string"
        },
        "message":{
            "description":"The response message.",
            "example":"The entities were added successfully.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"OK",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":200,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The success response details.",
    "type":"object"
}

401 Response

Unauthorized Access

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

422 Response

Unprocessable Entity. Usually due to not providing a required field.

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

500 Response

An internal server error occurred while accessing the database or performing a database operation.

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}