REST API endpoints for Project fields
Use the REST API to manage Project fields
List project fields for organization
List all fields for a specific organization-owned project.
Подробные маркеры доступа для "List project fields for organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Projects" organization permissions (read)
Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.
Параметры для "List project fields for organization"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
project_number integer Обязательное полеThe project's number. |
org string Обязательное полеThe organization name. The name is not case sensitive. |
| Имя., Тип, Description |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: |
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." |
Коды состояния http-ответа для "List project fields for organization"
| Код состояния | Описание |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Примеры кода для "List project fields for organization"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-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/fieldsResponse
Status: 200{
"id": 12345,
"node_id": "PVTF_lADOABCD1234567890",
"name": "Priority",
"data_type": "single_select",
"project_url": "https://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"
}Get project field for organization
Get a specific field for an organization-owned project.
Подробные маркеры доступа для "Get project field for organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Projects" organization permissions (read)
Эту конечную точку можно использовать без проверки подлинности или указанных выше разрешений, если запрашиваются только общедоступные ресурсы.
Параметры для "Get project field for organization"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
project_number integer Обязательное полеThe project's number. |
field_id integer Обязательное полеThe unique identifier of the field. |
org string Обязательное полеThe organization name. The name is not case sensitive. |
Коды состояния http-ответа для "Get project field for organization"
| Код состояния | Описание |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Примеры кода для "Get project field for organization"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-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/fields/FIELD_IDResponse
Status: 200{
"id": 12345,
"node_id": "PVTF_lADOABCD1234567890",
"name": "Priority",
"data_type": "single_select",
"project_url": "https://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"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
project_number integer Обязательное полеThe project's number. |
username string Обязательное полеThe handle for the GitHub user account. |
| Имя., Тип, Description |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: |
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." |
Коды состояния http-ответа для "List project fields for user"
| Код состояния | Описание |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Примеры кода для "List project fields for user"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fieldsResponse
Status: 200{
"id": 12345,
"node_id": "PVTF_lADOABCD1234567890",
"name": "Priority",
"data_type": "single_select",
"project_url": "https://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"
}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"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
project_number integer Обязательное полеThe project's number. |
field_id integer Обязательное полеThe unique identifier of the field. |
username string Обязательное полеThe handle for the GitHub user account. |
Коды состояния http-ответа для "Get project field for user"
| Код состояния | Описание |
|---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
Примеры кода для "Get project field for user"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields/FIELD_IDResponse
Status: 200{
"id": 12345,
"node_id": "PVTF_lADOABCD1234567890",
"name": "Priority",
"data_type": "single_select",
"project_url": "https://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"
}