project_views

Creates, updates, deletes, gets or lists a project_views resource.

Overview

Name	project_views
Type	Resource
Id	github.projects.project_views

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_view_for_org	insert	org, project_number, name, layout		Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.
create_view_for_user	insert	user_id, project_number, name, layout		Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
project_number	integer	The project's number.
user_id	string	The unique identifier of the user.

INSERT examples

create_view_for_org

Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.

INSERT INTO github.projects.project_views (
name,
layout,
filter,
visible_fields,
org,
project_number
)
SELECT 
'{{ name }}' /* required */,
'{{ layout }}' /* required */,
'{{ filter }}',
'{{ visible_fields }}',
'{{ org }}',
'{{ project_number }}'
RETURNING
id,
name,
node_id,
created_at,
creator,
filter,
group_by,
html_url,
layout,
number,
project_url,
sort_by,
updated_at,
vertical_group_by,
visible_fields
;

create_view_for_user

Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.

INSERT INTO github.projects.project_views (
name,
layout,
filter,
visible_fields,
user_id,
project_number
)
SELECT 
'{{ name }}' /* required */,
'{{ layout }}' /* required */,
'{{ filter }}',
'{{ visible_fields }}',
'{{ user_id }}',
'{{ project_number }}'
RETURNING
id,
name,
node_id,
created_at,
creator,
filter,
group_by,
html_url,
layout,
number,
project_url,
sort_by,
updated_at,
vertical_group_by,
visible_fields
;

Manifest

# Description fields are for documentation purposes
- name: project_views
props:
  - name: org
    value: "{{ org }}"
    description: Required parameter for the project_views resource.
  - name: project_number
    value: {{ project_number }}
    description: Required parameter for the project_views resource.
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the project_views resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the view.
  - name: layout
    value: "{{ layout }}"
    description: |
      The layout of the view.
    valid_values: ['table', 'board', 'roadmap']
  - name: filter
    value: "{{ filter }}"
    description: |
      The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.
  - name: visible_fields
    value:
      - {{ visible_fields }}
    description: |
      `visible_fields` is not applicable to `roadmap` layout views.
      For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.