Puntos de conexión de la API REST para las vistas del proyecto

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.

Tokens de acceso específicos para "Create a view for an organization-owned project"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Projects" organization permissions (write)

Parámetros para "Create a view for an organization-owned project"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Obligatorio The organization name. The name is not case sensitive.
`project_number` integer Obligatorio The project's number.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Obligatorio The name of the view.
`layout` string Obligatorio The layout of the view. Puede ser uno de los siguientes: `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.

Códigos de estado de respuesta HTTP para "Create a view for an organization-owned project"

status code	Descripción
`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

Ejemplos de código para "Create a view for an organization-owned project"

Ejemplos de solicitud

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.

Tokens de acceso específicos para "Create a view for a user-owned project"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Create a view for a user-owned project"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`user_id` string Obligatorio The unique identifier of the user.
`project_number` integer Obligatorio The project's number.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Obligatorio The name of the view.
`layout` string Obligatorio The layout of the view. Puede ser uno de los siguientes: `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.

Códigos de estado de respuesta HTTP para "Create a view for a user-owned project"

status code	Descripción
`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

Ejemplos de código para "Create a view for a user-owned project"

Ejemplos de solicitud

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
    ]
  }
}