Create a Queue View

Create a queue view in your SysAid account. Column, filter and sort field names are resolved against SysAid's field catalog; an unknown name answers 400, naming it. A "PUBLIC" queue view requires a SysAid Admin (403 otherwise), and a duplicate name among the caller's own queue views answers 409. isDefault is not set on create; use the update operation.

Body Params

The queue view to create.

string
required
length between 1 and 250

The name of the queue view. A blank name answers 400. Leading and trailing whitespace is trimmed.

string
enum
Defaults to PRIVATE

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

Column field names in display order; omitted uses SysAid's default list.

columns
filters
array of objects
length ≤ 50

The filter conditions to configure. Omitted means no filters.

filters
sorts
array of objects
length ≤ 50

The sort rules to configure, applied in array order. Omitted means no sorts.

sorts
groupIds
array of integers, unique

The unique identifiers of the groups to share a "PUBLIC" queue view with. Omitted or empty shares the queue view with every group. Not accepted on a "PRIVATE" queue view (400). Group existence is not validated. Use the Groups API to retrieve group details.

groupIds
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