GraphQL APIリソース

このドキュメントはGitLabの現在のGraphQLスキーマに基づいて自己生成されたものです。

APIはGraphiQL IDEを使ってインタラクティブに探索することができます。

以下の各表は、GraphQL タイプを文書化したものです。型はモデルと緩やかに一致しますが、モデル上のすべてのフィールドとメソッドが GraphQL 経由で利用できるわけではありません。

caution
非推奨のフィールドには{warning-solid}が付けられています。私たちの非推奨プロセスに従って削除された項目(フィールド、列挙型など)は、削除された項目にあります。

Query タイプ

Query 型は、すべての実行可能クエリのための API のトップレベルのエントリポイントを含んでいます。

Query.abuseReport

不正使用レポーターの検索

caution
16.3で導入。この機能は実験です。いつでも変更や削除が可能です。

AbuseReport を返します。

引数

名前種類説明
id AbuseReportID!不正利用レポートのID。

Query.abuseReportLabels

不正利用報告ラベル。

caution
16.3で導入。この機能は実験です。いつでも変更や削除が可能です。

LabelConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
searchTerm Stringを含むラベルを検索するための検索語。

Query.aiMessages

AIメッセージを検索します。

caution
16.1 で導入されました。この機能は実験です。いつでも変更または削除できます。

AiCachedMessageTypeConnection! を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
requestIds [ID!]取得するリクエスト ID の配列。
roles [AiCachedMessageRole!]フェッチするロールの配列。

Query.auditEventDefinitions

インスタンスで利用可能なすべての監査イベントの定義。

AuditEventDefinitionConnection! を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

Query.boardList

イシュー・ボードのリストを検索します。

BoardList を返します。

引数

名前種類説明
id ListID!リストのグローバルID。
issueFilters BoardIssueInput掲示板リストでイシューのメタデータを取得する際に適用されるフィルタです。

Query.ciApplicationSettings

インスタンス全体に適用されるCI関連の設定。

CiApplicationSettings を返します。

Query.ciCatalogResource

作成者が閲覧可能な単一のCI/CDカタログリソースです。

caution
16.1 で導入されました。この機能は実験です。いつでも変更または削除できます。

CiCatalogResource を返します。

引数

名前種類説明
id CiCatalogResourceID!CI/CDカタログリソースのグローバルIDです。

Query.ciCatalogResources

共通の名前空間の下にあるすべてのCI/CDカタログリソースは、作成者が見ることができます。

caution
15.11で導入。この機能は実験です。いつでも変更または削除できます。

CiCatalogResourceConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
projectPath ID名前空間カタログを持つプロジェクト。
sort CiCatalogResourceSort指定された基準でカタログ・リソースを並べ替えます。

Query.ciConfig

CIコンフィグの内容をリント処理したもの。1回のリクエストで複数回リクエストされるべきではありません。

CiConfig を返します。

引数

名前種類説明
content String! .gitlab-ci.yml の内部。
dryRun Booleanパイプライン作成シミュレーションの実行、または静的チェックのみ。
projectPath ID!CIコンフィグのプロジェクト。
sha Stringパイプラインのシャ

Query.ciMinutesUsage

ネームスペースの使用量データを計算します。

CiMinutesNamespaceMonthlyUsageConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
date Date利用データを取得する日付。
namespaceId NamespaceID月間コンピュート使用量のNamespaceのグローバルID。

Query.ciPipelineStage

CIパイプラインに属するステージ。

CiStage を返します。

引数

名前種類説明
id CiStageID!CIステージのグローバルID。

Query.ciVariables

インスタンスのCI/CD変数のリスト。

CiInstanceVariableConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
sort CiVariableSort結果のソート順

Query.containerRepository

コンテナリポジトリを検索します。

ContainerRepositoryDetails を返します。

引数

名前種類説明
id ContainerRepositoryID!コンテナリポジトリのグローバル ID。

Query.currentLicense

現在のライセンスに関連するフィールド。

CurrentLicense を返します。

Query.currentUser

現在のユーザーに関する情報を取得します。

UserCore を返します。

Query.designManagement

デザイン管理に関連するフィールド。

DesignManagement! を返します。

Query.devopsAdoptionEnabledNamespaces

設定された DevOps 採用ネームスペースを取得します。BETAこのエンドポイントは予告なく変更される場合があります。

DevopsAdoptionEnabledNamespaceConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
displayNamespaceId NamespaceID名前空間の表示でフィルタリングします。

Query.echo

API を検証するためのテスト用エンドポイント。

String! を返します。

引数

名前種類説明
text String!エコーバックするテキスト。

Query.epicBoardList

EpicList を返します。

引数

名前種類説明
epicFilters EpicFiltersエピックボードリストでエピックメタデータを取得する際に適用されるフィルター。
id BoardsEpicListID!リストのグローバルID。

Query.explainVulnerabilityPrompt

この脆弱性について説明する 指定した脆弱性についてプロンプトを表示します。

caution
16.2で導入されました。この機能は実験です。いつでも変更または削除することができます。

ExplainVulnerabilityPrompt を返します。

引数

名前種類説明
vulnerabilityId VulnerabilityID!のプロンプトを生成する脆弱性。

Query.geoNode

Geoノードを検索します。

GeoNode を返します。

引数

名前種類説明
name StringGeo ノードの名前。デフォルトは現在の Geo ノード名です。

Query.gitpodEnabled

アプリケーション設定で Gitpod が有効になっているかどうか。

Boolean を返します。

Query.group

グループを検索します。

Group を返します。

引数

名前種類説明
fullPath ID!プロジェクト、グループ、またはネームスペースのフルパス。例えば、gitlab-org/gitlab-foss

Query.groups

グループを検索します。

GroupConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
search Stringグループ名またはグループのフルパスでクエリを検索します。

Query.instanceExternalAuditEventDestinations

インスタンスレベルの外部監査イベント宛先。

InstanceExternalAuditEventDestinationConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

Query.instanceSecurityDashboard

インスタンス・セキュリティ・ダッシュボードに関連するフィールド。

InstanceSecurityDashboard を返します。

Query.issue

イシューを検索します。

Issue を返します。

引数

名前種類説明
id IssueID!イシューのグローバルID。

Query.issues

現在のユーザーが閲覧可能なイシューを検索します。少なくとも1つのフィルタを指定する必要があります。

caution
15.6 で導入。この機能は実験です。いつでも変更や削除が可能です。

IssueConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
assigneeId Stringイシューに割り当てられたユーザーのID。ワイルドカード値 “NONE “および “ANY “がサポートされています。
assigneeUsername {警告ソリッド} String13.11で非推奨assigneeUsernames を使用してください。
assigneeUsernames [String!]イシューに割り当てられたユーザーのユーザー名。
assigneeWildcardId AssigneeWildcardId担当者ワイルドカードでフィルタします。assigneeUsernameおよびassigneeUsernamesとは互換性がありません。
authorUsername Stringイシューの作成者のユーザ名です。
closedAfter Timeこの日付以降にクローズされたイシュー。
closedBefore Timeこの日より前に終了したイシュー
confidential Boolean機密イシューをフィルタリングします。false “の場合、機密issueを除外します。true “の場合、機密issueのみを返します。
createdAfter Timeこの日付以降に作成されたイシュー。
createdBefore Timeこの日より前に作成されたイシュー。
crmContactId Stringイシューに割り当てられた担当者のID。
crmOrganizationId Stringイシューに割り当てられた組織のID
epicId Stringイシューに関連付けられたエピックのID。”none “および “any “の値がサポートされています。
epicWildcardId EpicWildcardIdエピックIDのワイルドカードでフィルタリングします。epicIdと互換性がありません。
healthStatusFilter HealthStatusFilterイシューの健康状態、”none” および “any” 値がサポートされています。
iid StringイシューのIID。例えば “1”。
iids [String!]イシューのIIDのリスト。例えば、["1", "2"]
in [IssuableSearchableField!]検索を実行するフィールドを指定します。デフォルトは[TITLE, DESCRIPTION]です。search 引数が必要です。
includeArchived Booleanアーカイブされたプロジェクトのイシューを含めるかどうかを指定します。デフォルトはfalseです。
includeSubepics BooleanepicIdでイシューをフィルタリングする際にサブepicを含めるかどうか。
iterationCadenceId [IterationsCadenceID!]反復ケイデンスIDのリストでフィルタリングします。
iterationId [ID]イシューに適用された反復グローバルIDのリスト。
iterationTitle String反復のタイトルでフィルタします。
iterationWildcardId IterationWildcardId反復IDワイルドカードによるフィルタリング。
labelName [String]このイシューに適用されるラベル。
milestoneTitle [String]このイシューにマイルストーンが適用されました。
milestoneWildcardId MilestoneWildcardIdマイルストーンIDのワイルドカードでイシューをフィルタリングします。
myReactionEmoji String現在のユーザーによって適用されたリアクションの絵文字でフィルタリングします。ワイルドカード値「NONE」と「ANY」がサポートされています。
not NegatedIssueFilterInput否定された引数
or UnionedIssueFilterInputORを含む引数のリスト
search Stringタイトルまたは説明の検索クエリ。
sort IssueSortこの条件でイシューを並べ替えます。
state IssuableStateこのイシューの現在の状態。
types [IssueType!]指定されたイシュー・タイプによってイシューをフィルタリングします。
updatedAfter Timeこの日以降に更新されたイシュー
updatedBefore Timeこの日以前に更新されたイシュー
weight Stringイシューに適用される重み。”none “および “any “の値がサポートされています。
weightWildcardId WeightWildcardId重みIDのワイルドカードによるフィルタリング。weightと互換性がありません。

Query.iteration

反復を検索します。

Iteration を返します。

引数

名前種類説明
id IterationID!イテレーションをIDで検索します。

Query.jobs

この GitLab インスタンス上のすべてのジョブ。

CiJobConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
runnerTypes {警告ソリッド} [CiRunnerType!]16.4で導入されました。この機能はExperimentです。いつでも変更または削除できます。機能フラグ:admin_jobs_filter_runner_type が有効な場合、ジョブをRunnerタイプでフィルタリングします。
statuses [CiJobStatus!]ステータスでジョブをフィルタリングします。

Query.licenseHistoryEntries

ライセンス履歴のエントリに関連するフィールド。

LicenseHistoryEntryConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

Query.mergeRequest

マージリクエストを検索します。

MergeRequest を返します。

引数

名前種類説明
id MergeRequestID!マージリクエストのグローバルID。

Query.metadata

GitLab に関するメタデータ。

Metadata を返します。

Query.milestone

マイルストーンの検索

Milestone を返します。

引数

名前種類説明
id MilestoneID!マイルストーンをIDで検索します。

Query.namespace

ネームスペースを検索します。

Namespace を返します。

引数

名前種類説明
fullPath ID!プロジェクト、グループ、またはネームスペースのフルパス。例えば、gitlab-org/gitlab-foss

Query.note

ノートを検索します。

caution
15.9で導入。この機能は実験です。いつでも変更や削除が可能です。

Note を返します。

引数

名前種類説明
id NoteID!ノートのグローバルID。

Query.organization

組織を検索します。

caution
16.4で導入。この機能はエクスペリメントです。いつでも変更または削除できます。

Organization を返します。

引数

名前種類説明
id OrganizationsOrganizationID!組織のID。

Query.package

パッケージを検索します。このフィールドは、1 つのリクエストで 1 つのクエリに対してのみ解決できます。パッケージにdefault ステータスがない場合はnull を返します。

PackageDetailsType を返します。

引数

名前種類説明
id PackagesPackageID!パッケージのグローバルID。

Query.project

プロジェクトを検索します。

Project を返します。

引数

名前種類説明
fullPath ID!プロジェクト、グループ、またはネームスペースのフルパス。例えば、gitlab-org/gitlab-foss

Query.projects

現在のユーザーが表示可能なプロジェクトを検索します。

ProjectConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
ids [ID!]ID でプロジェクトを絞り込みます。
membership Boolean現在のユーザーが所属しているプロジェクトのみを返します。
search String検索クエリ。プロジェクト名、パス、説明のいずれかを指定できます。
searchNamespaces Booleanプロジェクト検索に名前空間を含めることができます。
sort String結果のソート順フォーマット:<field_name>_<sort_direction>例:id_desc またはname_asc
topics [String!]プロジェクトをトピックで絞り込みます。
withIssuesEnabled Booleanイシューが有効なプロジェクトのみを返します。
withMergeRequestsEnabled Booleanマージリクエストが有効なプロジェクトのみを返します。

Query.queryComplexity

GraphQL クエリの複雑さに関する情報。

QueryComplexity を返します。

Query.runner

ランナーを探す

CiRunner を返します。

引数

名前種類説明
id CiRunnerID!ランナーID.

Query.runnerPlatforms

サポートされているランナー・プラットフォーム。

caution
15.9 で非推奨。サポートされているプラットフォームについては gitlab-runner ドキュメント を参照してください。

RunnerPlatformConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

Query.runnerSetup

ランナーのセットアップ方法。

caution
15.9では非推奨。ランナー登録コマンドについては gitlab-runner ドキュメント を参照してください。

RunnerSetup を返します。

引数

名前種類説明
architecture String!インストラクションを生成するアーキテクチャ。
groupId {警告ソリッド} GroupID13.11で非推奨。使用されなくなりました。
platform String!インストラクションを生成するプラットフォーム。
projectId {警告ソリッド} ProjectID13.11で非推奨。使用されなくなりました。

Query.runners

現在のユーザーが閲覧可能なランナーを検索します。

CiRunnerConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
active {警告ソリッド} Boolean14.8で非推奨。これは改名されました。使用法:paused.
paused Boolean paused (true)またはactive (false)のステータスでランナーをフィルタリングします。
search String説明フィールドの完全なトークンまたは部分的なテキストでフィルタリングします。
sort CiRunnerSort結果のソート順
status CiRunnerStatusランナーをステータスで絞り込みます。
tagList [String!]ランナーに関連するタグ(カンマ区切りまたは配列)でフィルタリングします。
type CiRunnerTypeタイプによるランナーのフィルタリング。
upgradeStatus CiRunnerUpgradeStatusアップグレードステータスでフィルタリングします。

Query.snippets

現在のユーザーに表示されているスニペットを検索します。

SnippetConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
authorId UserID作成者のID。
explore Boolean個人のスニペットを検索します。
ids [SnippetID!]グローバルスニペットIDの配列。例えば、gid://gitlab/ProjectSnippet/1.
projectId ProjectIDプロジェクトのID。
type TypeEnumスニペットのタイプ。
visibility VisibilityScopesEnumスニペットの可視性。

Query.subscriptionFutureEntries

将来の購読のエントリに関連するフィールド。

SubscriptionFutureEntryConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

Query.syntheticNote

合成ノートを検索します。

caution
15.9で導入。この機能は実験です。いつでも変更や削除が可能です。

Note を返します。

引数

名前種類説明
noteableId NoteableID!合成ノートを検索するリソースのグローバルID。
sha String!ノートのグローバルID。

Query.timelogs

現在のユーザーに表示されているタイムログを検索します。

TimelogConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
endDate Timeログに記録された日付が endDate 以前である日付範囲内のタイムログを一覧表示します。
endTime Timeログに記録された時刻がendTime以前である時間範囲のタイムログをリストアップします。
groupId GroupIDグループのタイムログを一覧表示します。
projectId ProjectIDプロジェクトのタイムログを一覧表示します。
sort TimelogSortタイムログを特定の順番で表示します。
startDate Timeログに記録された日付が startDate 以降である日付範囲内のタイムログを一覧表示します。
startTime Timeログに記録された時間が startTime 以降である時間範囲のタイムログをリストアップします。
username Stringユーザーのタイムログを一覧表示します。

Query.todo

単一のTo-Do項目を取得します。

Todo を返します。

引数

名前種類説明
id TodoID!To-Do 項目の ID。

Query.topics

プロジェクトのトピックを検索します。

TopicConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
search Stringトピック名の検索クエリ。

Query.usageTrendsMeasurements

インスタンスの統計情報を取得します。

UsageTrendsMeasurementConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
identifier MeasurementIdentifier!取得する測定または統計のタイプ。
recordedAfter Timeこの日以降に記録された測定
recordedBefore Timeこの日より前に記録された測定。

Query.user

ユーザーを検索します。

UserCore を返します。

引数

名前種類説明
id UserIDユーザーのID。
username Stringユーザーのユーザー名。

Query.users

ユーザーを検索します。

UserCoreConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
admins Boolean管理者ユーザーのみを返します。
ids [ID!]ユーザーグローバルIDのリスト。
search String名前、ユーザー名、プライマリEメールでユーザーを検索するクエリ。
sort Sortこの条件でユーザーを並べ替えます。
usernames [String!]ユーザー名のリスト

Query.vulnerabilities

現在のユーザーのインスタンスセキュリティダッシュボードのプロジェクトでレポーターされた脆弱性。

VulnerabilityConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
clusterAgentId [ClustersAgentID!] cluster_agent_id によって脆弱性をフィルタします。reportTypecluster_image_scanning の脆弱性は、このフィルタにのみ含まれます。
clusterId [ClustersClusterID!] cluster_id によって脆弱性をフィルタします。reportTypecluster_image_scanning の脆弱性は、このフィルタにのみ含まれます。
dismissalReason [VulnerabilityDismissalReason!]却下理由によるフィルタ。却下された脆弱性だけがフィルタに含まれます。
hasIssues Booleanリンクされたイシューを持つ脆弱性のみを返します。
hasResolution Booleanデフォルトブランチで解決済みの脆弱性のみを返します。
image [String!]位置画像による脆弱性のフィルタリング。このフィルタが存在する場合、レスポンスはcontainer_scanning,cluster_image_scanning を含むreportType のエントリにのみマッチします。
projectId [ID!]プロジェクトで脆弱性をフィルタします。
reportType [VulnerabilityReportType!]レポートの種類で脆弱性をフィルタリングします。
scanner [String!]脆弱性をVulnerabilityScanner.externalIdでフィルタリングします。
scannerId [VulnerabilitiesScannerID!]脆弱性をスキャナIDでフィルタリングします。
severity [VulnerabilitySeverity!]重大度による脆弱性のフィルタリング。
sort VulnerabilitySort脆弱性をソート順で一覧表示します。
state [VulnerabilityState!]脆弱性を状態別にフィルタリングします。

Query.vulnerabilitiesCountByDay

現在のユーザーのインスタンスセキュリティダッシュボード上のプロジェクトの 1 日あたりの脆弱性の履歴数。

VulnerabilitiesCountByDayConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
endDate ISO8601Date!脆弱性履歴を取得する最終日。
startDate ISO8601Date!脆弱性履歴を取得する最初の日。

Query.vulnerability

脆弱性を検索します。

Vulnerability を返します。

引数

名前種類説明
id VulnerabilityID!脆弱性のグローバルID。

Query.workItem

作業項目を検索します。

caution
15.1で導入。この機能は実験です。いつでも変更または削除できます。

WorkItem を返します。

引数

名前種類説明
id WorkItemID!ワークアイテムのグローバルID。

Query.workspace

ワークスペースを検索します。

caution
16.0で導入。この機能は実験です。いつでも変更や削除が可能です。

Workspace を返します。

引数

名前種類説明
id RemoteDevelopmentWorkspaceID!ワークスペースをIDで検索します。

Query.workspaces

現在のユーザーが所有するワークスペースを ID で検索します。

caution
16.0で導入。この機能は実験です。いつでも変更や削除が可能です。

WorkspaceConnection を返します。

このフィールドは接続を返します。4つの標準ページ分割引数を受け付けます:before: Stringafter: String,first: Int,last: Int

引数

名前種類説明
ids [RemoteDevelopmentWorkspaceID!]グローバルワークスペースIDの配列。例えば、["gid://gitlab/RemoteDevelopment::Workspace/1"]
includeActualStates [String!]実際の状態のいずれかに一致するすべてのワークスペースを含みます。
projectIds [ProjectID!]プロジェクト ID でワークスペースをフィルタリングします。

Mutation タイプ

Mutation タイプには、実行可能なすべての変異が含まれています。

すべての変異はinput という名前の単一の入力オブジェクトで引数を受け取り、すべての変異はエラーメッセージのリストを含む少なくともリターンフィールドerrors をサポートします。

すべての入力オブジェクトは、変異を識別するclientMutationId: String フィールドを持つことができます。

使用例:

mutation($id: NoteableID!, $body: String!) {
  createNote(input: { noteableId: $id, body: $body }) {
    errors
  }
}

Mutation.achievementsAward

caution
15.10で導入。この機能は実験です。いつでも変更や削除が可能です。

入力タイプ:AchievementsAwardInput

引数

名前種類説明
achievementId AchievementsAchievementID!授与される業績のグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。
userId UserID!功績を授与されたユーザーのグローバルID。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
userAchievement UserAchievement功績賞。

Mutation.achievementsCreate

caution
15.8で導入されました。この機能は実験です。いつでも変更または削除できます。

入力タイプ:AchievementsCreateInput

引数

名前種類説明
avatar Upload実績のアバター
clientMutationId String変異を実行するクライアントの一意な識別子。
description String実績の説明またはメモ。
name String!実績の名前
namespaceId NamespaceID!実績の名前空間

フィールド

名前種類説明
achievement Achievement作成されたアチーブメント
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.achievementsDelete

caution
15.11で導入。この機能は実験です。いつでも変更または削除できます。

入力タイプ:AchievementsDeleteInput

引数

名前種類説明
achievementId AchievementsAchievementID!削除される実績のグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。

フィールド

名前種類説明
achievement Achievement達成。
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.achievementsRevoke

caution
15.10で導入。この機能は実験です。いつでも変更や削除が可能です。

入力タイプ:AchievementsRevokeInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
userAchievementId AchievementsUserAchievementID!取り消されるユーザー実績のグローバルID。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
userAchievement UserAchievement功績賞。

Mutation.achievementsUpdate

caution
15.11で導入。この機能は実験です。いつでも変更または削除できます。

入力タイプ:AchievementsUpdateInput

引数

名前種類説明
achievementId AchievementsAchievementID!更新される実績のグローバルID。
avatar Upload実績のアバター
clientMutationId String変異を実行するクライアントの一意な識別子。
description String実績の説明またはメモ。
name String実績の名前

フィールド

名前種類説明
achievement Achievement達成。
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.addProjectToSecurityDashboard

入力タイプ:AddProjectToSecurityDashboardInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
id ProjectID!インスタンスセキュリティダッシュボードに追加するプロジェクトの ID。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
project Projectインスタンスセキュリティダッシュボードに追加されたプロジェクト。

Mutation.adminSidekiqQueuesDeleteJobs

入力タイプ:AdminSidekiqQueuesDeleteJobsInput

引数

名前種類説明
aiResource Stringコンテキストメタデータのai_resourceにマッチするジョブを削除します。
artifactSize Stringコンテキストメタデータ内のartifact_sizeに一致するジョブを削除します。
artifactUsedCdn Stringコンテキストメタデータの artifact_used_cdn に一致するジョブを削除します。
artifactsDependenciesCount Stringコンテキストメタデータ内の artifacts_dependencies_count に一致するジョブを削除します。
artifactsDependenciesSize Stringコンテキストメタデータ内の artifacts_dependencies_size に一致するジョブを削除します。
callerId Stringコンテキストメタデータ内の caller_id に一致するジョブを削除します。
clientId Stringコンテキストメタデータ内のclient_idに一致するジョブを削除します。
clientMutationId String変異を実行するクライアントの一意な識別子。
featureCategory Stringコンテキストメタデータ内の feature_category に一致するジョブを削除します。
jobId Stringコンテキストメタデータのjob_idにマッチするジョブを削除します。
mergeActionStatus Stringコンテキストメタデータ内のmerge_action_statusに一致するジョブを削除します。
pipelineId Stringコンテキストメタデータ内の pipeline_id に一致するジョブを削除します。
project Stringコンテキストメタデータ内のプロジェクトにマッチするジョブを削除します。
queueName String!ジョブを削除するキューの名前。
relatedClass Stringコンテキストメタデータ内の related_class に一致するジョブを削除します。
remoteIp Stringコンテキストメタデータの remote_ip にマッチするジョブを削除します。
rootCallerId Stringコンテキストメタデータの root_caller_id にマッチするジョブを削除します。
rootNamespace Stringコンテキストメタデータ内の root_namespace に一致するジョブを削除します。
subscriptionPlan Stringコンテキストメタデータ内のsubscription_planにマッチするジョブを削除します。
user Stringコンテキストメタデータ内のユーザーにマッチするジョブを削除します。
userId Stringコンテキストメタデータ内のuser_idに一致するジョブを削除します。
workerClass String指定されたワーカークラスのジョブを削除します。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
result DeleteJobsResponse削除要求のステータスに関する情報。

Mutation.aiAction

caution
15.11で導入。この機能は実験です。いつでも変更または削除できます。

入力タイプ:AiActionInput

引数

名前種類説明
analyzeCiJobFailure AnalyzeCiJobFailureInputanalyze_ci_job_failure AIアクションの入力。
chat AiChatInputchat AIアクションの入力。
clientMutationId String変異を実行するクライアントの一意な識別子。
clientSubscriptionId String変異に対する応答を受け取るためにサブスクライブすることができる、クライアントが生成したID。
explainCode AiExplainCodeInputexplain_code AIアクションの入力。
explainVulnerability AiExplainVulnerabilityInputexplain_vulnerability AIアクションの入力。
fillInMergeRequestTemplate AiFillInMergeRequestTemplateInputfill_in_merge_request_template AIアクションの入力。
generateCommitMessage AiGenerateCommitMessageInputgenerate_commit_message AIアクションの入力。
generateDescription AiGenerateDescriptionInputgenerate_description AIアクションの入力。
generateTestFile GenerateTestFileInputgenerate_test_file AIアクションの入力。
markupFormat {警告ソリッド} MarkupFormat 非推奨:contentHtml属性に移動しました。16.4で非推奨。
summarizeComments AiSummarizeCommentsInputsummary_comments AIアクションの入力。
summarizeReview AiSummarizeReviewInputsummaryize_review AIアクションの入力。
tanukiBot AiTanukiBotInputtanuki_bot AIアクションの入力。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
requestId StringリクエストのID

Mutation.alertSetAssignees

入力タイプ:AlertSetAssigneesInput

引数

名前種類説明
assigneeUsernames [String!]!アラートに割り当てるユーザ名。デフォルトでは既存の担当者を置き換えます。
clientMutationId String変異を実行するクライアントの一意な識別子。
iid String!変異させるアラートのIID。
operationMode MutationOperationMode実行するオペレーション。デフォルトは REPLACE です。
projectPath ID!変異させるアラートのプロジェクト。

フィールド

名前種類説明
alert AlertManagementAlert変異後の警告
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
issue Issue変異後に発生したイシュー。
todo Todo変異後のTo-Do項目。

Mutation.alertTodoCreate

入力タイプ:AlertTodoCreateInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
iid String!変異させるアラートのIID。
projectPath ID!変異させるアラートのプロジェクト。

フィールド

名前種類説明
alert AlertManagementAlert変異後の警告
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
issue Issue変異後に発生したイシュー。
todo Todo変異後のTo-Do項目。

Mutation.approveDeployment

入力タイプ:ApproveDeploymentInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
comment String承認者のコメント。
id DeploymentID!デプロイのID。
representedAs Stringユーザが複数の承認ルールに属している場合に、承認に使用するユーザ/グループ/ロールの名前。
status DeploymentsApprovalStatus!承認のステータス (APPROVED またはREJECTED)。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
deploymentApproval DeploymentApproval!変異後の DeploymentApproval。
errors [String!]!変異の実行中に発生したエラー。

Mutation.artifactDestroy

入力タイプ:ArtifactDestroyInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
id CiJobArtifactID!削除するアーティファクトのID。

フィールド

名前種類説明
artifact CiJobArtifact削除されたアーティファクト。
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.auditEventsStreamingDestinationEventsAdd

入力タイプ:AuditEventsStreamingDestinationEventsAddInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsExternalAuditEventDestinationID!宛先ID。
eventTypeFilters [String!]!ストリーミングのために追加するイベントタイプのフィルタのリスト。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
eventTypeFilters [String!]監査イベント外部宛先のイベント・タイプ・フィルタのリスト。

Mutation.auditEventsStreamingDestinationEventsRemove

入力タイプ:AuditEventsStreamingDestinationEventsRemoveInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsExternalAuditEventDestinationID!宛先ID。
eventTypeFilters [String!]!ストリーミングから削除するイベントタイプフィルターのリスト。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

入力タイプ:AuditEventsStreamingDestinationInstanceEventsAddInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsInstanceExternalAuditEventDestinationID!宛先ID。
eventTypeFilters [String!]!ストリーミングのために追加するイベントタイプのフィルタのリスト。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
eventTypeFilters [String!]監査イベント外部宛先のイベント・タイプ・フィルタのリスト。

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

入力タイプ:AuditEventsStreamingDestinationInstanceEventsRemoveInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsInstanceExternalAuditEventDestinationID!宛先ID。
eventTypeFilters [String!]!ストリーミングから削除するイベントタイプフィルターのリスト。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.auditEventsStreamingHeadersCreate

入力タイプ:AuditEventsStreamingHeadersCreateInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsExternalAuditEventDestinationID!ヘッダを関連付ける宛先。
key String!ヘッダーのキー。
value String!ヘッダーの値。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
header AuditEventStreamingHeader作成されたヘッダー。

Mutation.auditEventsStreamingHeadersDestroy

入力タイプ:AuditEventsStreamingHeadersDestroyInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
headerId AuditEventsStreamingHeaderID!削除するヘッダ。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.auditEventsStreamingHeadersUpdate

入力タイプ:AuditEventsStreamingHeadersUpdateInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
headerId AuditEventsStreamingHeaderID!更新するヘッダ。
key String!ヘッダーのキー。
value String!ヘッダーの値。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
header AuditEventStreamingHeaderヘッダーを更新しました。

Mutation.auditEventsStreamingInstanceHeadersCreate

入力タイプ:AuditEventsStreamingInstanceHeadersCreateInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
destinationId AuditEventsInstanceExternalAuditEventDestinationID!ヘッダを関連付けるインスタンスレベルの外部宛先。
key String!ヘッダーのキー。
value String!ヘッダーの値。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
header AuditEventsStreamingInstanceHeader作成されたヘッダー。

Mutation.auditEventsStreamingInstanceHeadersDestroy

入力タイプ:AuditEventsStreamingInstanceHeadersDestroyInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
headerId AuditEventsStreamingInstanceHeaderID!削除するヘッダ。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.auditEventsStreamingInstanceHeadersUpdate

入力タイプ:AuditEventsStreamingInstanceHeadersUpdateInput

引数

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
headerId AuditEventsStreamingInstanceHeaderID!更新するヘッダ。
key String!ヘッダーのキー。
value String!ヘッダーの値。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
header AuditEventsStreamingInstanceHeaderヘッダーを更新しました。

Mutation.awardEmojiAdd

入力タイプ:AwardEmojiAddInput

引数

名前種類説明
awardableId AwardableID!受賞リソースのグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。
name String!絵文字の名前

フィールド

名前種類説明
awardEmoji AwardEmoji突然変異後の絵文字の反応
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.awardEmojiRemove

入力タイプ:AwardEmojiRemoveInput

引数

名前種類説明
awardableId AwardableID!受賞リソースのグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。
name String!絵文字の名前

フィールド

名前種類説明
awardEmoji AwardEmoji突然変異後の絵文字の反応
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。

Mutation.awardEmojiToggle

入力タイプ:AwardEmojiToggleInput

引数

名前種類説明
awardableId AwardableID!受賞リソースのグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。
name String!絵文字の名前

フィールド

名前種類説明
awardEmoji AwardEmoji突然変異後の絵文字の反応
clientMutationId String変異を実行するクライアントの一意な識別子。
errors [String!]!変異の実行中に発生したエラー。
toggledOn Boolean!絵文字の状態を示します。トグルが絵文字を獲得した場合はtrueを、絵文字を削除した場合はfalseを返します。

Mutation.boardEpicCreate

入力タイプ:BoardEpicCreateInput

引数

名前種類説明
boardId BoardsEpicBoardID!エピックがあるボードのグローバルID。
clientMutationId String変異を実行するクライアントの一意な識別子。
groupPath ID!作成するエピックが属するグループ。
listId BoardsEpicListID!エピックが作成されるエピックボードリストのグローバルID。
title String!エピックのタイトル。

フィールド

名前種類説明
clientMutationId String変異を実行するクライアントの一意な識別子。
epic Epic作成後のエピック。
errors [String!]!変異の実行中に発生したエラー。

Mutation.boardListCreate