REST API endpoints for Project views - GitHub Enterprise Cloud Docs

Create a view for an organization-owned project

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

“Create a view for an organization-owned project”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

"Projects" organization permissions (write)

“Create a view for an organization-owned project”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`project_number` integer 必须 The project's number.

正文参数
名称, 类型, 说明
`name` string 必须 The name of the view.
`layout` string 必须 The layout of the view. 可以是以下选项之一: `table`, `board`, `roadmap`
`filter` string The filter query for the view. See Filtering projects for more information.
`visible_fields` array of integers `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.

“Create a view for an organization-owned project”的 HTTP 响应状态代码

状态代码	说明
`201`	Response for creating a view in an organization-owned project.
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`503`	Service unavailable

“Create a view for an organization-owned project”的示例代码

如果你通过 GHE.com 访问 GitHub，请将 api.github.com 替换为你的企业在 api.SUBDOMAIN.ghe.com 上的专用子域。

请求示例

Select the example type

post/orgs/{org}/projectsV2/{project_number}/views

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/views \
  -d '{"name":"All Issues","layout":"table","filter":"is:issue","visible_fields":[123,456,789]}'

Response for creating a table view

Status: 201

{
  "value": {
    "id": 1,
    "number": 1,
    "name": "Sprint Board",
    "layout": "board",
    "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI",
    "project_url": "https://api.github.com/orgs/octocat/projectsV2/1",
    "html_url": "https://github.com/orgs/octocat/projects/1/views/1",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2022-04-28T12:00:00Z",
    "updated_at": "2022-04-28T12:00:00Z",
    "filter": "is:issue is:open",
    "visible_fields": [
      123,
      456,
      789
    ],
    "sort_by": [
      [
        123,
        "asc"
      ],
      [
        456,
        "desc"
      ]
    ],
    "group_by": [
      123
    ],
    "vertical_group_by": [
      456
    ]
  }
}

Create a view for a user-owned project

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

“Create a view for a user-owned project”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Create a view for a user-owned project”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`user_id` string 必须 The unique identifier of the user.
`project_number` integer 必须 The project's number.

正文参数
名称, 类型, 说明
`name` string 必须 The name of the view.
`layout` string 必须 The layout of the view. 可以是以下选项之一: `table`, `board`, `roadmap`
`filter` string The filter query for the view. See Filtering projects for more information.
`visible_fields` array of integers `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.

“Create a view for a user-owned project”的 HTTP 响应状态代码

状态代码	说明
`201`	Response for creating a view in a user-owned project.
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`503`	Service unavailable

“Create a view for a user-owned project”的示例代码

如果你通过 GHE.com 访问 GitHub，请将 api.github.com 替换为你的企业在 api.SUBDOMAIN.ghe.com 上的专用子域。

请求示例

Select the example type

post/users/{user_id}/projectsV2/{project_number}/views

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/users/USER_ID/projectsV2/PROJECT_NUMBER/views \
  -d '{"name":"All Issues","layout":"table","filter":"is:issue","visible_fields":[123,456,789]}'

Response for creating a table view

Status: 201

{
  "value": {
    "id": 1,
    "number": 1,
    "name": "Sprint Board",
    "layout": "board",
    "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI",
    "project_url": "https://api.github.com/orgs/octocat/projectsV2/1",
    "html_url": "https://github.com/orgs/octocat/projects/1/views/1",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2022-04-28T12:00:00Z",
    "updated_at": "2022-04-28T12:00:00Z",
    "filter": "is:issue is:open",
    "visible_fields": [
      123,
      456,
      789
    ],
    "sort_by": [
      [
        123,
        "asc"
      ],
      [
        456,
        "desc"
      ]
    ],
    "group_by": [
      123
    ],
    "vertical_group_by": [
      456
    ]
  }
}