issue_field_values

Creates, updates, deletes, gets or lists an issue_field_values resource.

Overview

Name	`issue_field_values`
Type	Resource
Id	`github.issues.issue_field_values`

Fields

The following fields are returned by SELECT queries:

list_issue_field_values_for_issue

Response

Name	Datatype	Description
`issue_field_id`	`integer (int64)`	Unique identifier for the issue field.
`node_id`	`string`	(example: IFT_GDKND)
`data_type`	`string`	The data type of the issue field (text, single_select, number, date) (example: text)
`single_select_option`	`object`	Details about the selected option (only present for single_select fields)
`value`	`string`	The value of the issue field (example: Sample text)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`list_issue_field_values_for_issue`	`select`	`owner`, `repo`, `issue_number`	`per_page`, `page`	Lists all issue field values for an issue.
`add_issue_field_values`	`insert`	`repository_id`, `issue_number`		Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. Adding an empty array will clear all existing field values for the issue. This endpoint supports the following field data types: - `text`: String values for text fields - `single_select`: Option names for single-select fields (must match an existing option name) - `number`: Numeric values for number fields - `date`: ISO 8601 date strings for date fields Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
`set_issue_field_values`	`replace`	`repository_id`, `issue_number`		Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. This endpoint supports the following field data types: - `text`: String values for text fields - `single_select`: Option names for single-select fields (must match an existing option name) - `number`: Numeric values for number fields - `date`: ISO 8601 date strings for date fields This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
`delete_issue_field_value`	`delete`	`repository_id`, `issue_number`, `issue_field_id`		Remove a specific custom field value from an issue. Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. If the specified field does not have a value set on the issue, this operation will return a `404` error. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

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
`issue_field_id`	`integer`	The unique identifier of the issue field.
`issue_number`	`integer`	The number that identifies the issue.
`owner`	`string`	The account owner of the repository. The name is not case sensitive.
`repo`	`string`	The name of the repository without the `.git` extension. The name is not case sensitive.
`repository_id`	`integer`	The unique identifier of the repository.
`page`	`integer`	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
`per_page`	`integer`	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

`SELECT` examples

list_issue_field_values_for_issue

Lists all issue field values for an issue.

SELECT
issue_field_id,
node_id,
data_type,
single_select_option,
value
FROM github.issues.issue_field_values
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND issue_number = '{{ issue_number }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

`INSERT` examples

add_issue_field_values
Manifest

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.
Adding an empty array will clear all existing field values for the issue.

This endpoint supports the following field data types:
- text: String values for text fields
- single_select: Option names for single-select fields (must match an existing option name)
- number: Numeric values for number fields
- date: ISO 8601 date strings for date fields

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API"
and "Best practices for using the REST API."

INSERT INTO github.issues.issue_field_values (
issue_field_values,
repository_id,
issue_number
)
SELECT 
'{{ issue_field_values }}',
'{{ repository_id }}',
'{{ issue_number }}'
RETURNING
issue_field_id,
node_id,
data_type,
single_select_option,
value
;

# Description fields are for documentation purposes
- name: issue_field_values
props:
  - name: repository_id
    value: {{ repository_id }}
    description: Required parameter for the issue_field_values resource.
  - name: issue_number
    value: {{ issue_number }}
    description: Required parameter for the issue_field_values resource.
  - name: issue_field_values
    description: |
      An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.
    value:
      - field_id: {{ field_id }}
        value: "{{ value }}"

`REPLACE` examples

set_issue_field_values

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

This endpoint supports the following field data types:
- text: String values for text fields
- single_select: Option names for single-select fields (must match an existing option name)
- number: Numeric values for number fields
- date: ISO 8601 date strings for date fields

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API"
and "Best practices for using the REST API."

REPLACE github.issues.issue_field_values
SET 
issue_field_values = '{{ issue_field_values }}'
WHERE 
repository_id = '{{ repository_id }}' --required
AND issue_number = '{{ issue_number }}' --required
RETURNING
issue_field_id,
node_id,
data_type,
single_select_option,
value;

`DELETE` examples

delete_issue_field_value

Remove a specific custom field value from an issue.

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

If the specified field does not have a value set on the issue, this operation will return a 404 error.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API"
and "Best practices for using the REST API."

DELETE FROM github.issues.issue_field_values
WHERE repository_id = '{{ repository_id }}' --required
AND issue_number = '{{ issue_number }}' --required
AND issue_field_id = '{{ issue_field_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​