REST API for Unified Assurance Vision

Update Multiple General Settings

post

/vision/api/generalSettings/import

Updates the general settings defined in the request body entirely. Not recommended for external use.
The setting definitions in the request body replace the settings' existing definitions. You must provide the entire setting definition, taking care to only change the value of the value property. Changing other properties may cause unintended UI issues. Any settings that do not already exist are added, but settings other than the default ones are ignored.
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 GeneralSetting

The general setting details.

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

Nested Schema : GeneralSetting

Type: object

The general setting details.

Show Source

id: integer (int64)

The setting ID.

Example: 3
max: number (double)

The maximum value for the setting. Only used for settings with the number type.

Example: 20
min: number (double)

The minimum value for the setting. Only used for settings with the number type.

Example: 0
name: string

The setting name.

Example: Default Zoom
type: string

The setting type.

Example: number
value: string

The setting value.

Example: 7

{
    "properties":{
        "id":{
            "description":"The setting ID.",
            "example":3,
            "format":"int64",
            "type":"integer"
        },
        "max":{
            "description":"The maximum value for the setting. Only used for settings with the <b>number</b> type.",
            "example":20,
            "format":"double",
            "type":"number"
        },
        "min":{
            "description":"The minimum value for the setting. Only used for settings with the <b>number</b> type.",
            "example":0,
            "format":"double",
            "type":"number"
        },
        "name":{
            "description":"The setting name.",
            "example":"Default Zoom",
            "type":"string"
        },
        "type":{
            "description":"The setting type.",
            "example":"number",
            "type":"string"
        },
        "value":{
            "description":"The setting value.",
            "example":"7",
            "type":"string"
        }
    },
    "description":"The general setting details.",
    "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"
}