Update a Queue View

Partially update an existing queue view that the calling user can see in your SysAid account. Every property is optional, but at least one must be given; an omitted property keeps its stored value unchanged, and a given "columns", "filters" or "sorts" array replaces the stored array wholesale rather than merging it entry by entry. A kept column, or a filter unchanged from what was stored (identical "field", "type" and "values"), keeps its stored catalog metadata; only a new column name, a changed filter, or any given sort is resolved against SysAid's field catalog, and a name the catalog does not carry answers 400, naming it. Ticket Management detects no version conflict on this update, so a concurrent write is not detected and the last write wins. Setting isDefault to true makes this the caller's default queue view. Setting isDefault to false on the caller's current default queue view answers 409, since a default queue view is always required; setting isDefault to false on any other queue view has no effect. Turning a "PRIVATE" queue view "PUBLIC" requires the caller to be a SysAid Admin, answering 403 otherwise. groupIds is accepted only when the queue view's resulting visibility is "PUBLIC"; given on a queue view whose resulting visibility is "PRIVATE" answers 400, and switching a queue view to "PRIVATE" clears any groups it was shared with. On a "PUBLIC" queue view, groupIds omitted keeps the stored groups unchanged; given, it replaces them, sharing with every group when empty. Updating a queue view that is "PUBLIC" before the update also requires a SysAid Admin (403). A name already used by another of the caller's own queue views answers 409. The queue view is found the same way as by Get a Queue View, so another user's "PRIVATE" queue view, an asset queue view, or one outside that approximately 50-view window answers 404. The update writes back the queue view as SysAid lists it, and depending on the account that listing drops the requester's company column, filter and sort and merges an assigned-group column into the assignee column, so on such a queue view those changes are stored too, as when it is saved in Spaces. Returns the bare, mapped queue view, taken from SysAid's own response to the update.

Path Params
integer
required
1 to 2147483647

The unique identifier of the queue view in SysAid, as an integer from 1 to 2147483647.

Body Params

The queue view properties to update. At least one property must be given; every omitted property keeps its stored value.

string
length between 1 and 250

The new name of the queue view. A name that is empty once leading/trailing whitespace is trimmed answers 400.

string
enum

Whether a queue view is "PRIVATE" (visible only to its owner) or "PUBLIC" (shared with one or more groups, with all groups, or, for a SysAid Admin, every "PUBLIC" queue view in the account).

Allowed:
columns
array of strings, unique
length between 1 and 50

The field names of the columns to configure, replacing the stored columns wholesale, in SysAid's own field naming and the order to display them in. A kept name reuses its stored catalog metadata; a new name is resolved against SysAid's field catalog, and a name the catalog does not carry answers 400, naming it.

columns
filters
array of objects

The filter conditions to configure, replacing the stored filters wholesale. An entry identical to a stored one (same field, type and values) keeps its stored metadata; any other entry is resolved against SysAid's field catalog, as on create.

filters
sorts
array of objects

The sort rules to configure, applied in array order and replacing the stored sort rules wholesale.

sorts
groupIds
array of integers, unique

The unique identifiers of the groups to share a "PUBLIC" queue view with, replacing the stored groups wholesale. Omitted keeps the stored groups unchanged. Empty shares with every group. Not accepted when the queue view's resulting visibility is "PRIVATE" (400). Group existence is not validated.

groupIds
boolean

Whether this queue view should become the calling user's default. Setting it to false on the caller's current default queue view answers 409; setting it to false on any other queue view has no effect.

Responses

502

SysAid returned an unexpected or failed response. Other upstream 4xx/5xx statuses may also be passed through.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json