프로젝트 필드의 REST API 엔드포인트

List project fields for organization

List all fields for a specific organization-owned project.

"List project fields for organization"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

"Projects" organization permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"List project fields for organization"에 대한 매개 변수

머리글
속성, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
속성, 형식, 설명
`project_number` integer Required The project's number.
`org` string Required The organization name. The name is not case sensitive.

쿼리 매개 변수
속성, 형식, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`before` string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
`after` string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

"List project fields for organization"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"List project fields for organization"에 대한 코드 샘플

GHE.com에서 GitHub에 액세스하는 경우 api.github.com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/orgs/{org}/projectsV2/{project_number}/fields

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200

[
  {
    "id": 12345,
    "node_id": "PVTF_lADOABCD1234567890",
    "name": "Priority",
    "data_type": "single_select",
    "project_url": "http://api.github.com/projects/67890",
    "options": [
      {
        "id": "option_1",
        "name": "Low",
        "color": "GREEN",
        "description": "Low priority items"
      },
      {
        "id": "option_2",
        "name": "Medium",
        "color": "YELLOW",
        "description": "Medium priority items"
      },
      {
        "id": "option_3",
        "name": "High",
        "color": "RED",
        "description": "High priority items"
      }
    ],
    "created_at": "2022-04-28T12:00:00Z",
    "updated_at": "2022-04-28T12:00:00Z"
  },
  {
    "id": 67891,
    "node_id": "PVTF_lADOABCD9876543210",
    "name": "Status",
    "data_type": "single_select",
    "project_url": "http://api.github.com/projects/67890",
    "options": [
      {
        "id": "option_4",
        "name": "Todo",
        "color": "GRAY",
        "description": "Items to be worked on"
      },
      {
        "id": "option_5",
        "name": "In Progress",
        "color": "BLUE",
        "description": "Items currently being worked on"
      },
      {
        "id": "option_6",
        "name": "Done",
        "color": "GREEN",
        "description": "Completed items"
      }
    ],
    "created_at": "2022-04-29T10:30:00Z",
    "updated_at": "2022-04-29T10:30:00Z"
  },
  {
    "id": 24680,
    "node_id": "PVTF_lADOABCD2468024680",
    "name": "Team notes",
    "data_type": "text",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-05-15T08:00:00Z",
    "updated_at": "2022-05-15T08:00:00Z"
  },
  {
    "id": 13579,
    "node_id": "PVTF_lADOABCD1357913579",
    "name": "Story points",
    "data_type": "number",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-06-01T14:30:00Z",
    "updated_at": "2022-06-01T14:30:00Z"
  },
  {
    "id": 98765,
    "node_id": "PVTF_lADOABCD9876598765",
    "name": "Due date",
    "data_type": "date",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-06-10T09:15:00Z",
    "updated_at": "2022-06-10T09:15:00Z"
  },
  {
    "id": 11223,
    "node_id": "PVTF_lADOABCD1122311223",
    "name": "Sprint",
    "data_type": "iteration",
    "project_url": "http://api.github.com/projects/67890",
    "configuration": {
      "duration": 14,
      "start_day": 1,
      "iterations": [
        {
          "id": "iter_1",
          "title": "Sprint 1",
          "start_date": "2022-07-01",
          "duration": 14
        },
        {
          "id": "iter_2",
          "title": "Sprint 2",
          "start_date": "2022-07-15",
          "duration": 14
        }
      ]
    },
    "created_at": "2022-06-20T16:45:00Z",
    "updated_at": "2022-06-20T16:45:00Z"
  }
]

Get project field for organization

Get a specific field for an organization-owned project.

"Get project field for organization"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

"Projects" organization permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"Get project field for organization"에 대한 매개 변수

머리글
속성, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
속성, 형식, 설명
`project_number` integer Required The project's number.
`field_id` integer Required The unique identifier of the field.
`org` string Required The organization name. The name is not case sensitive.

"Get project field for organization"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"Get project field for organization"에 대한 코드 샘플

GHE.com에서 GitHub에 액세스하는 경우 api.github.com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/orgs/{org}/projectsV2/{project_number}/fields/{field_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200

{
  "id": 12345,
  "node_id": "PVTF_lADOABCD1234567890",
  "name": "Priority",
  "data_type": "single_select",
  "project_url": "http://api.github.com/projects/67890",
  "options": [
    {
      "id": "option_1",
      "name": "Low",
      "color": "GREEN",
      "description": "Low priority items"
    },
    {
      "id": "option_2",
      "name": "Medium",
      "color": "YELLOW",
      "description": "Medium priority items"
    },
    {
      "id": "option_3",
      "name": "High",
      "color": "RED",
      "description": "High priority items"
    }
  ],
  "created_at": "2022-04-28T12:00:00Z",
  "updated_at": "2022-04-28T12:00:00Z"
}

List project fields for user

List all fields for a specific user-owned project.

"List project fields for user"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"List project fields for user"에 대한 매개 변수

머리글
속성, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
속성, 형식, 설명
`project_number` integer Required The project's number.
`username` string Required The handle for the GitHub user account.

쿼리 매개 변수
속성, 형식, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`before` string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
`after` string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

"List project fields for user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"List project fields for user"에 대한 코드 샘플

GHE.com에서 GitHub에 액세스하는 경우 api.github.com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/users/{username}/projectsV2/{project_number}/fields

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200

[
  {
    "id": 12345,
    "node_id": "PVTF_lADOABCD1234567890",
    "name": "Priority",
    "data_type": "single_select",
    "project_url": "http://api.github.com/projects/67890",
    "options": [
      {
        "id": "option_1",
        "name": "Low",
        "color": "GREEN",
        "description": "Low priority items"
      },
      {
        "id": "option_2",
        "name": "Medium",
        "color": "YELLOW",
        "description": "Medium priority items"
      },
      {
        "id": "option_3",
        "name": "High",
        "color": "RED",
        "description": "High priority items"
      }
    ],
    "created_at": "2022-04-28T12:00:00Z",
    "updated_at": "2022-04-28T12:00:00Z"
  },
  {
    "id": 67891,
    "node_id": "PVTF_lADOABCD9876543210",
    "name": "Status",
    "data_type": "single_select",
    "project_url": "http://api.github.com/projects/67890",
    "options": [
      {
        "id": "option_4",
        "name": "Todo",
        "color": "GRAY",
        "description": "Items to be worked on"
      },
      {
        "id": "option_5",
        "name": "In Progress",
        "color": "BLUE",
        "description": "Items currently being worked on"
      },
      {
        "id": "option_6",
        "name": "Done",
        "color": "GREEN",
        "description": "Completed items"
      }
    ],
    "created_at": "2022-04-29T10:30:00Z",
    "updated_at": "2022-04-29T10:30:00Z"
  },
  {
    "id": 24680,
    "node_id": "PVTF_lADOABCD2468024680",
    "name": "Team notes",
    "data_type": "text",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-05-15T08:00:00Z",
    "updated_at": "2022-05-15T08:00:00Z"
  },
  {
    "id": 13579,
    "node_id": "PVTF_lADOABCD1357913579",
    "name": "Story points",
    "data_type": "number",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-06-01T14:30:00Z",
    "updated_at": "2022-06-01T14:30:00Z"
  },
  {
    "id": 98765,
    "node_id": "PVTF_lADOABCD9876598765",
    "name": "Due date",
    "data_type": "date",
    "project_url": "http://api.github.com/projects/67890",
    "created_at": "2022-06-10T09:15:00Z",
    "updated_at": "2022-06-10T09:15:00Z"
  },
  {
    "id": 11223,
    "node_id": "PVTF_lADOABCD1122311223",
    "name": "Sprint",
    "data_type": "iteration",
    "project_url": "http://api.github.com/projects/67890",
    "configuration": {
      "duration": 14,
      "start_day": 1,
      "iterations": [
        {
          "id": "iter_1",
          "title": "Sprint 1",
          "start_date": "2022-07-01",
          "duration": 14
        },
        {
          "id": "iter_2",
          "title": "Sprint 2",
          "start_date": "2022-07-15",
          "duration": 14
        }
      ]
    },
    "created_at": "2022-06-20T16:45:00Z",
    "updated_at": "2022-06-20T16:45:00Z"
  }
]

Get project field for user

Get a specific field for a user-owned project.

"Get project field for user"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get project field for user"에 대한 매개 변수

머리글
속성, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
속성, 형식, 설명
`project_number` integer Required The project's number.
`field_id` integer Required The unique identifier of the field.
`username` string Required The handle for the GitHub user account.

"Get project field for user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"Get project field for user"에 대한 코드 샘플

GHE.com에서 GitHub에 액세스하는 경우 api.github.com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/users/{username}/projectsV2/{project_number}/fields/{field_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200

{
  "id": 12345,
  "node_id": "PVTF_lADOABCD1234567890",
  "name": "Priority",
  "data_type": "single_select",
  "project_url": "http://api.github.com/projects/67890",
  "options": [
    {
      "id": "option_1",
      "name": "Low",
      "color": "GREEN",
      "description": "Low priority items"
    },
    {
      "id": "option_2",
      "name": "Medium",
      "color": "YELLOW",
      "description": "Medium priority items"
    },
    {
      "id": "option_3",
      "name": "High",
      "color": "RED",
      "description": "High priority items"
    }
  ],
  "created_at": "2022-04-28T12:00:00Z",
  "updated_at": "2022-04-28T12:00:00Z"
}