REST API for Unified Assurance Vision

Update a General Setting

put

/vision/api/generalSettings/{id}

Updates the specified setting entirely. The setting definition in the request body replaces the setting's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

Admin
Viewer
Api

Request

Path Parameters

id(required): integer(int64)
The ID of the setting to update.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

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 : ResourceWrapper31

Type: object

The response resource wrapper.

Show Source

columns: array columns

Information about the columns used to display the requested or updated content.
content: content
links: array links

Links related to the requested or updated content.

{
    "properties":{
        "columns":{
            "description":"Information about the columns used to display the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/ColumnData"
            },
            "type":"array"
        },
        "content":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/GeneralSetting"
                },
                {
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/GeneralSetting"
                        },
                        {
                            "description":"The requested or updated content."
                        }
                    ]
                }
            ]
        },
        "links":{
            "description":"Links related to the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "type":"array"
        }
    },
    "description":"The response resource wrapper.",
    "type":"object"
}

Nested Schema : columns

Type: array

Information about the columns used to display the requested or updated content.

Show Source

Array of: object ColumnData

The details of columns to use to show data in a table.

{
    "description":"Information about the columns used to display the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/ColumnData"
    },
    "type":"array"
}

Nested Schema : content

Match All

Show Source

object schema

The general setting details.
allOf content-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GeneralSetting"
        },
        {
            "allOf":[
                {
                    "$ref":"#/components/schemas/GeneralSetting"
                },
                {
                    "description":"The requested or updated content."
                }
            ]
        }
    ]
}

Nested Schema : links

Type: array

Links related to the requested or updated content.

Show Source

Array of: object Link

The link details.

{
    "description":"Links related to the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "type":"array"
}

Nested Schema : ColumnData

Type: object

The details of columns to use to show data in a table.

Show Source

cssClass: string

The CSS class for the column.

Example: slick-header-column
defaultSortAsc: boolean

Whether to sort the column in ascending order by default (true) or not (false).

Example: true
editor: string

The editor to use for the column.

Example: TaskEnabledEditor
entity: string

The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.

Example: Task
field: string

The field to use for data in the column cells.

Example: enabled
focusable: boolean

Whether the column is focusable (true) or not (false).

Example: true
formatter: string

The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.

Example: CamelCaseFormatter
headerCssClass: string

The CSS class for the column header.

Example: slick-header-column
id: integer (int64)

The column ID.

Example: 130
maxWidth: integer (int32)

The maximum width for the column.

Example: 80
minWidth: integer (int32)

The minimum width for the column.

Example: 30
name: string

The column name, that appears in the header row.

Example: Enabled
options: string

Options for values in the column.

Example: true,false
rerenderOnResize: boolean

Whether the column should be rerendered when resized (true) or not (false).

Example: false
resizable: boolean

Whether the column can be resized (true) or not (false).

Example: true
selectable: boolean

Whether the column can be selected (true) or not (false).

Example: true
sortable: boolean

Whether the column can be used to sort the table (true) or not (false).

Example: true
tooltip: string

The tooltip to display for the column.

Example: Whether the task is enabled or disabled.
width: integer (int32)

The default width, in pixels, of the column.

Example: 50

{
    "properties":{
        "cssClass":{
            "description":"The CSS class for the column.",
            "example":"slick-header-column",
            "type":"string"
        },
        "defaultSortAsc":{
            "description":"Whether to sort the column in ascending order by default (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "editor":{
            "description":"The editor to use for the column.",
            "example":"TaskEnabledEditor",
            "type":"string"
        },
        "entity":{
            "description":"The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the <b>Settings</b> UI.",
            "example":"Task",
            "type":"string"
        },
        "field":{
            "description":"The field to use for data in the column cells.",
            "example":"enabled",
            "type":"string"
        },
        "focusable":{
            "description":"Whether the column is focusable (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "formatter":{
            "description":"The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like <b>true</b> to <b>True</b>.",
            "example":"CamelCaseFormatter",
            "type":"string"
        },
        "headerCssClass":{
            "description":"The CSS class for the column header.",
            "example":"slick-header-column",
            "type":"string"
        },
        "id":{
            "description":"The column ID.",
            "example":130,
            "format":"int64",
            "type":"integer"
        },
        "maxWidth":{
            "description":"The maximum width for the column.",
            "example":80,
            "format":"int32",
            "type":"integer"
        },
        "minWidth":{
            "description":"The minimum width for the column.",
            "example":30,
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "description":"The column name, that appears in the header row.",
            "example":"Enabled",
            "type":"string"
        },
        "options":{
            "description":"Options for values in the column.",
            "example":"true,false",
            "type":"string"
        },
        "rerenderOnResize":{
            "description":"Whether the column should be rerendered when resized (<b>true</b>) or not (<b>false</b>).",
            "example":false,
            "type":"boolean"
        },
        "resizable":{
            "description":"Whether the column can be resized (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "selectable":{
            "description":"Whether the column can be selected (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "sortable":{
            "description":"Whether the column can be used to sort the table (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "tooltip":{
            "description":"The tooltip to display for the column.",
            "example":"Whether the task is enabled or disabled.",
            "type":"string"
        },
        "width":{
            "description":"The default width, in pixels, of the column.",
            "example":50,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The details of columns to use to show data in a table.",
    "type":"object"
}

Nested Schema : content-allOf[1]

Match All

The requested or updated content.

Show Source

object schema

The general setting details.
The requested or updated content.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GeneralSetting"
        },
        {
            "description":"The requested or updated content."
        }
    ]
}

Nested Schema : schema

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"
}

Nested Schema : Link

Type: object

The link details.

Show Source

expects: object expects

Additional Properties Allowed: additionalProperties

Any input expected by the link.
href: string

The link reference.

Example: https://example.com/layers
method: string

The HTTP method used by the linked object.

Example: GET
rel: string

The relationship between the linked object and the current object.

Example: self

{
    "properties":{
        "expects":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"Any input expected by the link.",
            "example":"text",
            "type":"object"
        },
        "href":{
            "description":"The link reference.",
            "example":"https://example.com/layers",
            "type":"string"
        },
        "method":{
            "description":"The HTTP method used by the linked object.",
            "example":"GET",
            "type":"string"
        },
        "rel":{
            "description":"The relationship between the linked object and the current object.",
            "example":"self",
            "type":"string"
        }
    },
    "description":"The link details.",
    "type":"object"
}

Nested Schema : expects

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"Any input expected by the link.",
    "example":"text",
    "type":"object"
}

Any input expected by the link.

Example:

text

Nested Schema : additionalProperties

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"
}

404 Response

Resource not Found

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"
}