ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

このバージョンの GitHub Enterprise はこの日付をもって終了となります: このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2020-08-20. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

記事のバージョン: Enterprise Server 2.18

ミューテーション

ここには以下の内容があります:

ミューテーションについて

すべてのGraphQLスキーマは、クエリとミューテーションの両方についてルート型を持っています。 ミューテーション型は、サーバー上のデータを変更するGraphQLの操作を定義します。 これは、POSTPATCHDELETEといったHTTPのメソッドを実行するのに似ています。

詳しい情報については「ミューテーションについて」を参照してください。

addAssigneesToAssignable

Adds assignees to an assignable object.

入力フィールド

返値フィールド

名前 説明

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


addComment

Adds a comment to an Issue or Pull Request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentEdge (IssueCommentEdge)

The edge from the subject's comment connection.

subject (Node)

The subject.

timelineEdge (IssueTimelineItemEdge)

The edge from the subject's timeline connection.


addLabelsToLabelable

Adds labels to a labelable object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was labeled.


addProjectCard

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

入力フィールド

返値フィールド

名前 説明

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

Adds a column to a Project.

入力フィールド

返値フィールド

名前 説明

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.


addPullRequestReview

Adds a review to a Pull Request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The newly created pull request review.

reviewEdge (PullRequestReviewEdge)

The edge from the pull request's review connection.


addPullRequestReviewComment

Adds a comment to a review.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created comment.

commentEdge (PullRequestReviewCommentEdge)

The edge from the review's comment connection.


addReaction

Adds a reaction to a subject.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


addStar

Adds a star to a Starrable.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


changeUserStatus

Update your status on GitHub.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.


clearLabelsFromLabelable

Clears all labels from a labelable object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.


cloneProject

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

入力フィールド

返値フィールド

名前 説明

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.


cloneTemplateRepository

Create a new repository with the same files and directory structure as a template repository.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


closeIssue

Close an issue.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.


closePullRequest

Close a pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was closed.


convertProjectCardNoteToIssue

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

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


createBranchProtectionRule

Create a new branch protection rule.

入力フィールド

返値フィールド

名前 説明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckRun

Create a check run.

プレビュー通知

createCheckRun is available under the Checks preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createCheckSuite

Create a check suite.

プレビュー通知

createCheckSuite is available under the Checks preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


createContentAttachment

Create a content attachment.

プレビュー通知

createContentAttachment is available under the Create content attachments preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentAttachment (ContentAttachment)

The newly created content attachment.


createDeployment

Creates a new deployment event.

プレビュー通知

createDeployment is available under the Deployments preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.


createDeploymentStatus

Create a deployment status.

プレビュー通知

createDeploymentStatus is available under the Deployments preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.


createIssue

Creates a new issue.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.


createLabel

Creates a new label.

プレビュー通知

createLabel is available under the Labels preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.


createProject

Creates a new project.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.


createPullRequest

Create a new pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.


createRef

Create a new Git Ref.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.


createRepository

Create a new repository.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.


createTeamDiscussion

Creates a new team discussion.

プレビュー通知

createTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.


createTeamDiscussionComment

Creates a new team discussion comment.

プレビュー通知

createTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.


deleteBranchProtectionRule

Delete a branch protection rule.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteIssue

Deletes an Issue object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.


deleteIssueComment

Deletes an IssueComment object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteLabel

Deletes a label.

プレビュー通知

deleteLabel is available under the Labels preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteProject

Deletes a project.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.


deleteProjectCard

Deletes a project card.

入力フィールド

返値フィールド

名前 説明

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

Deletes a project column.

入力フィールド

返値フィールド

名前 説明

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.


deletePullRequestReview

Deletes a pull request review.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.


deletePullRequestReviewComment

Deletes a pull request review comment.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.


deleteRef

Delete a Git Ref.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussion

Deletes a team discussion.

プレビュー通知

deleteTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


deleteTeamDiscussionComment

Deletes a team discussion comment.

プレビュー通知

deleteTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.


dismissPullRequestReview

Dismisses an approved or rejected pull request review.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.


importProject

Creates a new project by importing columns and a list of issues/PRs.

プレビュー通知

importProject is available under the Import project preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.


lockLockable

Lock a lockable object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

The item that was locked.


markPullRequestReadyForReview

Marks a pull request ready for review.

プレビュー通知

markPullRequestReadyForReview is available under the Draft pull requests preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.


mergeBranch

Merge a head into a branch.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.


mergePullRequest

Merge a pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was merged.


minimizeComment

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

プレビュー通知

minimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.


moveProjectCard

Moves a project card to another place.

入力フィールド

返値フィールド

名前 説明

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.


moveProjectColumn

Moves a project column to another place.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.


pinIssue

Pin an issue to a repository.

プレビュー通知

pinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.


removeAssigneesFromAssignable

Removes assignees from an assignable object.

入力フィールド

返値フィールド

名前 説明

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.


removeLabelsFromLabelable

Removes labels from a Labelable object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The Labelable the labels were removed from.


removeOutsideCollaborator

Removes outside collaborator from all repositories in an organization.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

removedUser (User)

The user that was removed as an outside collaborator.


removeReaction

Removes a reaction from a subject.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

subject (Reactable)

The reactable subject.


removeStar

Removes a star from a Starrable.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.


reopenIssue

Reopen a issue.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.


reopenPullRequest

Reopen a pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.


requestReviews

Set review requests on a pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.


rerequestCheckSuite

Rerequests an existing check suite.

プレビュー通知

rerequestCheckSuite is available under the Checks preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.


resolveReviewThread

Marks a review thread as resolved.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


submitPullRequestReview

Submits a pending pull request review.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.


unlockLockable

Unlock a lockable object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

unlockedRecord (Lockable)

The item that was unlocked.


unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

The issue or pull request that was marked as a duplicate.


unminimizeComment

Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.

プレビュー通知

unminimizeComment is available under the Minimize comments preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

unminimizedComment (Minimizable)

The comment that was unminimized.


unpinIssue

Unpin a pinned issue from a repository.

プレビュー通知

unpinIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was unpinned.


unresolveReviewThread

Marks a review thread as unresolved.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.


updateBranchProtectionRule

Create a new branch protection rule.

入力フィールド

返値フィールド

名前 説明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckRun

Update a check run.

プレビュー通知

updateCheckRun is available under the Checks preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.


updateCheckSuitePreferences

Modifies the settings of an existing check suite.

プレビュー通知

updateCheckSuitePreferences is available under the Checks preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateIssue

Updates an Issue.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.


updateIssueComment

Updates an IssueComment object.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.


updateLabel

Updates an existing label.

プレビュー通知

updateLabel is available under the Labels preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.


updateProject

Updates an existing project.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.


updateProjectCard

Updates an existing project card.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.


updateProjectColumn

Updates an existing project column.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.


updatePullRequest

Update a pull request.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.


updatePullRequestReview

Updates the body of a pull request review.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The updated pull request review.


updatePullRequestReviewComment

Updates a pull request review comment.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.


updateRef

Update a Git Ref.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The updated Ref.


updateRepository

Update information about a repository.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.


updateSubscription

Updates the state for subscribable subjects.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.


updateTeamDiscussion

Updates a team discussion.

プレビュー通知

updateTeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.


updateTeamDiscussionComment

Updates a discussion comment.

プレビュー通知

updateTeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.


updateTopics

Replaces the repository's topics with the given topics.

入力フィールド

返値フィールド

名前 説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invalidTopicNames ([String!])

Names of the provided topics that are not valid.

repository (Repository)

The updated repository.


担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください