Views
Represents the views used to organize and display tickets based on defined conditions.
Table-Specific Information
Select
The following queries are processed server-side while other filters are processed client-side by the provider. Allowed for agents.
SELECT * FROM Views WHERE Id = '123'
SELECT * FROM Views WHERE GroupId = '123'
SELECT * FROM Views WHERE Access = 'Shared'
SELECT * FROM Views WHERE Active = true
SELECT * FROM Views ORDER BY CreatedAt
SELECT * FROM Views ORDER BY UpdatedAt
SELECT * FROM Views WHERE Id in (18578482641937, 18578439448081)
Insert
The Title and ConditionsAll columns are required to insert. A suitable combination of Field, Operator, and Value is required for insertion in ConditionsAll and ConditionsAny. See a list of the possible combinations here. This operation is allowed for logged-in users with the "agent" role.
INSERT INTO ViewsConditionsAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO ViewsConditionsAny#temp(Field, Operator, Value) VALUES('assignee_id', 'is', '18211830670225')
INSERT INTO Views(Title,ConditionsAll, ConditionsAny, ExecutionColumns, ExecutionGroupBy, ExecutionGroupOrder, ExecutionSortBy, ExecutionSortOrder) VALUES('Test title', 'ViewsConditionsAll#temp', 'ViewsConditionsAny#temp', 'status;requester;asignee', 'asignee', 'desc', 'status', 'desc')
Update
You must specify the Id of the view to update it. ConditionsAll and ConditionsAny aggregate columns support duplicate values in the object, so in order to update these fields, you must specify the whole aggregate object. All fields that are not readonly are optional. This operation is allowed for logged-in users with the "agent" role.
INSERT INTO ViewsConditionsAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO ViewsConditionsAny#temp(Field, Operator, Value) VALUES('assignee_id', 'is', '18211830670225')
UPDATE Views SET Title='Updated Title', ConditionsAll='ViewsConditionsAll#temp', ConditionsAny='ViewsConditionsAny#temp' WHERE Id='18551415691665'
To update multiple views:
INSERT INTO Views#temp(Id, Position) VALUES(18578482641937, 5)
INSERT INTO Views#temp(Id, Position) VALUES(18578439448081, 6)
UPDATE VIEWS(Id, Position) Select Id, Position FROM Views#temp
Delete
You must specify the Id of the view to delete it. This operation is allowed for logged-in users with the "agent" role.
DELETE FROM Views WHERE Id = '123'
To delete multiple views:
INSERT INTO Views#temp(Id) VALUES(18578482641937)
INSERT INTO Views#temp(Id) VALUES(18578439448081)
DELETE FROM Views WHERE EXISTS Select Id FROM Views#temp
Note: For bulk updates and deletes, if any Id in the request is invalid, the API returns a "404 not found" error. When this happens, LastResultInfo#temp for this table shows an empty result set.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The Id of the view, automatically assigned when it is created. | |
| Title | String | False |
The title of the view. | |
| Active | Boolean | False |
Indicates whether the view should be displayed. | |
| SlaId | Long | False |
SlaPolicies.Id |
The Id of the associated SLA policy, if the view is for an SLA. |
| RestrictionId | Long | True |
The Id of the restriction that controls who can access this view. Null when everyone in the account can access it. | |
| RestrictionType | String | False |
The type of restriction that controls who can access this view. Null when everyone in the account can access it. | |
| RestrictionIds | String | False |
The numeric Ids of one or more groups. Recommended for the Group restriction type. | |
| Position | Integer | False |
The position of the view. | |
| ExecutionGroupBy | String | False |
The column by which tickets are grouped. The subject and submitter columns are not supported. | |
| ExecutionGroupOrder | String | False |
The sort order for grouped tickets. Possible values are asc and desc. | |
| ExecutionSortBy | String | False |
The column by which tickets are sorted. The subject and submitter columns are not supported. | |
| ExecutionSortOrder | String | False |
The sort order for tickets. Possible values are asc and desc. | |
| ExecutionGroup | String | False |
When present, the structure indicating how the tickets are grouped. | |
| ExecutionSort | String | False |
The column structure of the field used for sorting. | |
| ExecutionColumns | String | False |
The ticket fields to display. For insert, provide the values as a semicolon-separated list. | |
| ExecutionFields | String | False |
An object describing the field definitions included in the view's execution configuration. | |
| ExecutionCustomFields | String | False |
An object describing the custom field definitions included in the view's execution configuration. | |
| ConditionsAll | String | False |
Logical AND. Tickets must fulfill all of the conditions to be considered matching. Conditions is an object describing how the view is constructed. | |
| ConditionsAny | String | False |
Logical OR. Tickets may satisfy any of the conditions to be considered matching. Conditions is an object describing how the view is constructed. | |
| CreatedAt | Datetime | True |
The date and time when the view was created. | |
| UpdatedAt | Datetime | True |
The date and time when the view was last updated. | |
| Access | String | False |
The access level of the view. Possible values are personal, shared, or account. | |
| GroupId | Long | False |
Groups.Id |
The Id of the group the view belongs to. Used to query the table. |
| Default | Boolean | False |
Indicates whether the view is a default view. | |
| Description | String | False |
The description of the view. | |
| RawTitle | String | False |
The raw title of the view. | |
| Url | String | True |
The API URL of this view. |