このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2026-06-02. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください。

Reference documentation for GraphQL schema types in the Projects (classic) category.

この記事で

Mutations

addProjectCard

Mutation

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

addProjectCard の入力フィールド

addProjectCard の戻り値フィールド

名前説明

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.

addProjectColumn

Mutation

Adds a column to a Project.

addProjectColumn の入力フィールド

addProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.

cloneProject

Mutation

Creates a new project by cloning configuration from an existing project.

cloneProject の入力フィールド

cloneProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.

convertProjectCardNoteToIssue

Mutation

Convert a project note card to one associated with a newly created issue.

convertProjectCardNoteToIssue の入力フィールド

convertProjectCardNoteToIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

createProject

Mutation

Creates a new project.

createProject の入力フィールド

createProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

deleteProject

Mutation

Deletes a project.

deleteProject の入力フィールド

deleteProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.

deleteProjectCard

Mutation

Deletes a project card.

deleteProjectCard の入力フィールド

deleteProjectCard の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.

deleteProjectColumn

Mutation

Deletes a project column.

deleteProjectColumn の入力フィールド

deleteProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.

linkRepositoryToProject

Mutation

Creates a repository link for a project.

linkRepositoryToProject の入力フィールド

linkRepositoryToProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

moveProjectCard

Mutation

Moves a project card to another place.

moveProjectCard の入力フィールド

moveProjectCard の戻り値フィールド

名前説明

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.

moveProjectColumn

Mutation

Moves a project column to another place.

moveProjectColumn の入力フィールド

moveProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.

unlinkRepositoryFromProject

Mutation

Deletes a repository link from a project.

unlinkRepositoryFromProject の入力フィールド

unlinkRepositoryFromProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

updateProject

Mutation

Updates an existing project.

updateProject の入力フィールド

updateProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Mutation

Updates an existing project card.

updateProjectCard の入力フィールド

updateProjectCard の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Mutation

Updates an existing project column.

updateProjectColumn の入力フィールド

updateProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

Objects

AddedToProjectEvent

Object

Represents aadded_to_projectevent on a given issue or pull request.

AddedToProjectEvent 実装

AddedToProjectEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the AddedToProjectEvent object.

project (Project)

Project referenced by event.

projectCard (ProjectCard)

Project card referenced by this project event.

projectColumnName (String!)

Column name referenced by this project event.

MovedColumnsInProjectEvent

Object

Represents amoved_columns_in_projectevent on a given issue or pull request.

MovedColumnsInProjectEvent 実装

MovedColumnsInProjectEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the MovedColumnsInProjectEvent object.

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

project (Project)

Project referenced by event.

projectCard (ProjectCard)

Project card referenced by this project event.

projectColumnName (String!)

Column name the issue or pull request was moved to.

Project

Object

Projects manage issues, pull requests and notes within a project owner.

Project 実装

Project のフィールド

名前説明

body (String)

The project's description body.

bodyHTML (HTML!)

The projects description body rendered to HTML.

closed (Boolean!)

Indicates if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

columns (ProjectColumnConnection!)

List of columns in the project.

columns の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who originally created the project.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Project object.

name (String!)

The project's name.

number (Int!)

The project's number.

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

pendingCards の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

progress (ProjectProgress!)

Project progress details.

resourcePath (URI!)

The HTTP path for this project.

state (ProjectState!)

Whether the project is open or closed.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this project.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

ProjectCard

Object

A card in a project.

ProjectCard 実装

ProjectCard のフィールド

名前説明

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created in a pending state and has yet to be associated with a column. Once cards are associated with a column, they will not become pending in the future.

content (ProjectCardItem)

The card content item.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this card.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectCard object.

isArchived (Boolean!)

Whether the card is archived.

note (String)

The card note.

project (Project!)

The project that contains this card.

resourcePath (URI!)

The HTTP path for this card.

state (ProjectCardState)

The state of ProjectCard.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this card.

ProjectCardConnection

Object

The connection type for ProjectCard.

ProjectCardConnection のフィールド

名前説明

edges ([ProjectCardEdge])

A list of edges.

nodes ([ProjectCard])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectCardEdge

Object

An edge in a connection.

ProjectCardEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (ProjectCard)

The item at the end of the edge.

ProjectColumn

Object

A column inside a project.

ProjectColumn 実装

ProjectColumn のフィールド

名前説明

cards (ProjectCardConnection!)

List of cards in the column.

cards の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectColumn object.

name (String!)

The project column's name.

project (Project!)

The project that contains this column.

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

resourcePath (URI!)

The HTTP path for this project column.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this project column.

ProjectColumnConnection

Object

The connection type for ProjectColumn.

ProjectColumnConnection のフィールド

名前説明

edges ([ProjectColumnEdge])

A list of edges.

nodes ([ProjectColumn])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectColumnEdge

Object

An edge in a connection.

ProjectColumnEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (ProjectColumn)

The item at the end of the edge.

ProjectConnection

Object

A list of projects associated with the owner.

ProjectConnection のフィールド

名前説明

edges ([ProjectEdge])

A list of edges.

nodes ([Project])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectEdge

Object

An edge in a connection.

ProjectEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (Project)

The item at the end of the edge.

ProjectProgress

Object

Project progress stats.

ProjectProgress のフィールド

名前説明

doneCount (Int!)

The number of done cards.

donePercentage (Float!)

The percentage of done cards.

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

inProgressCount (Int!)

The number of in-progress cards.

inProgressPercentage (Float!)

The percentage of in-progress cards.

todoCount (Int!)

The number of to do cards.

todoPercentage (Float!)

The percentage of to do cards.

RemovedFromProjectEvent

Object

Represents aremoved_from_projectevent on a given issue or pull request.

RemovedFromProjectEvent 実装

RemovedFromProjectEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the RemovedFromProjectEvent object.

project (Project)

Project referenced by event.

projectColumnName (String!)

Column name referenced by this project event.

Interfaces

ProjectOwner

Interface

Represents an owner of a Project.

ProjectOwner は次で実装されています

ProjectOwner のフィールド

名前説明

id (ID!)

The Node ID of the ProjectOwner object.

project (Project)

Find project by number.

project の引数

  • number (Int!)

    The project number to find.

projects (ProjectConnection!)

A list of projects under the owner.

projects の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectOrder)

    Ordering options for projects returned from the connection.

  • search (String)

    Query to search projects by, currently only searching by name.

projectsResourcePath (URI!)

The HTTP path listing owners projects.

projectsUrl (URI!)

The HTTP URL listing owners projects.

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

Enums

ProjectCardArchivedState

Enum

The possible archived states of a project card.

ProjectCardArchivedState の値です。

名前説明
ARCHIVED

A project card that is archived.

NOT_ARCHIVED

A project card that is not archived.

ProjectCardState

Enum

Various content states of a ProjectCard.

ProjectCardState の値です。

名前説明
CONTENT_ONLY

The card has content only.

NOTE_ONLY

The card has a note only.

REDACTED

The card is redacted.

ProjectColumnPurpose

Enum

The semantic purpose of the column - todo, in progress, or done.

ProjectColumnPurpose の値です。

名前説明
DONE

The column contains cards which are complete.

IN_PROGRESS

The column contains cards which are currently being worked on.

TODO

The column contains cards still to be worked on.

ProjectOrderField

Enum

Properties by which project connections can be ordered.

ProjectOrderField の値です。

名前説明
CREATED_AT

Order projects by creation time.

NAME

Order projects by name.

UPDATED_AT

Order projects by update time.

ProjectState

Enum

State of the project; eitheropenor 'closed'.

ProjectState の値です。

名前説明
CLOSED

The project is closed.

OPEN

The project is open.

ProjectTemplate

Enum

GitHub-provided templates for Projects.

ProjectTemplate の値です。

名前説明
AUTOMATED_KANBAN_V2

Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.

AUTOMATED_REVIEWS_KANBAN

Create a board with triggers to automatically move cards across columns with review automation.

BASIC_KANBAN

Create a board with columns for To do, In progress and Done.

BUG_TRIAGE

Create a board to triage and prioritize bugs with To do, priority, and Done columns.

Unions

ProjectCardItem

Union

Types that can be inside Project Cards.

ProjectCardItem の可能な型

Input objects

AddProjectCardInput

Input object

Autogenerated input type of AddProjectCard.

AddProjectCardInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

note (String)

The note on the card.

projectColumnId (ID!)

The Node ID of the ProjectColumn.

AddProjectColumnInput

Input object

Autogenerated input type of AddProjectColumn.

AddProjectColumnInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the column.

projectId (ID!)

The Node ID of the project.

CloneProjectInput

Input object

Autogenerated input type of CloneProject.

CloneProjectInput の入力フィールド

名前説明

body (String)

The description of the project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

name (String!)

The name of the project.

public (Boolean)

The visibility of the project, defaults to false (private).

sourceId (ID!)

The source project to clone.

targetOwnerId (ID!)

The owner ID to create the project under.

ConvertProjectCardNoteToIssueInput

Input object

Autogenerated input type of ConvertProjectCardNoteToIssue.

ConvertProjectCardNoteToIssueInput の入力フィールド

名前説明

body (String)

The body of the newly created issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCardId (ID!)

The ProjectCard ID to convert.

repositoryId (ID!)

The ID of the repository to create the issue in.

title (String)

The title of the newly created issue. Defaults to the card's note text.

CreateProjectInput

Input object

Autogenerated input type of CreateProject.

CreateProjectInput の入力フィールド

名前説明

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project.

ownerId (ID!)

The owner ID to create the project under.

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

template (ProjectTemplate)

The name of the GitHub-provided template.

DeleteProjectCardInput

Input object

Autogenerated input type of DeleteProjectCard.

DeleteProjectCardInput の入力フィールド

名前説明

cardId (ID!)

The id of the card to delete.

clientMutationId (String)

A unique identifier for the client performing the mutation.

DeleteProjectColumnInput

Input object

Autogenerated input type of DeleteProjectColumn.

DeleteProjectColumnInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to delete.

DeleteProjectInput

Input object

Autogenerated input type of DeleteProject.

DeleteProjectInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.

LinkRepositoryToProjectInput

Input object

Autogenerated input type of LinkRepositoryToProject.

LinkRepositoryToProjectInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to link to a Repository.

repositoryId (ID!)

The ID of the Repository to link to a Project.

MoveProjectCardInput

Input object

Autogenerated input type of MoveProjectCard.

MoveProjectCardInput の入力フィールド

名前説明

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

cardId (ID!)

The id of the card to move.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move it into.

MoveProjectColumnInput

Input object

Autogenerated input type of MoveProjectColumn.

MoveProjectColumnInput の入力フィールド

名前説明

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move.

ProjectCardImport

Input object

An issue or PR and its owning repository to be used in a project card.

ProjectCardImport の入力フィールド

名前説明

number (Int!)

The issue or pull request number.

repository (String!)

Repository name with owner (owner/repository).

ProjectColumnImport

Input object

A project column and a list of its issues and PRs.

ProjectColumnImport の入力フィールド

名前説明

columnName (String!)

The name of the column.

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

position (Int!)

The position of the column, starting from 0.

ProjectOrder

Input object

Ways in which lists of projects can be ordered upon return.

ProjectOrder の入力フィールド

名前説明

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectOrderField!)

The field in which to order projects by.

UnlinkRepositoryFromProjectInput

Input object

Autogenerated input type of UnlinkRepositoryFromProject.

UnlinkRepositoryFromProjectInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project linked to the Repository.

repositoryId (ID!)

The ID of the Repository linked to the Project.

UpdateProjectCardInput

Input object

Autogenerated input type of UpdateProjectCard.

UpdateProjectCardInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

note (String)

The note of ProjectCard.

projectCardId (ID!)

The ProjectCard ID to update.

UpdateProjectColumnInput

Input object

Autogenerated input type of UpdateProjectColumn.

UpdateProjectColumnInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project column.

projectColumnId (ID!)

The ProjectColumn ID to update.

UpdateProjectInput

Input object

Autogenerated input type of UpdateProject.

UpdateProjectInput の入力フィールド

名前説明

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of project.

projectId (ID!)

The Project ID to update.

public (Boolean)

Whether the project is public or not.

state (ProjectState)

Whether the project is open or closed.