検索API

検索へのAPIコールはすべて認証されなければなりません。

追加スコープ

Elasticsearch が有効な場合、Advanced Search APIとGroup Search APIで追加スコープが利用できます：blobs commits,notes,wiki_blobs.

高度な検索 API

指定したスコープで、GitLabインスタンス全体でグローバルに式を検索します。レスポンスはリクエストされたスコープに依存します。

GET /search

属性	種類	必須	説明
`scope`	文字列です。	はい	検索する範囲。値には`projects`,`issues`,`merge_requests`,`milestones`,`snippet_titles`,`users`が含まれます。追加スコープ：`blobscommits`,`notes`,`wiki_blobs`.
`search`	文字列です。	はい	検索クエリ。
`confidential`	boolean	なし	守秘義務によるフィルタリング。`issues` スコープをサポートします。他のスコープは無視されます。
`order_by`	文字列です。	なし	`created_at` のみが `created_at`許可されます。`created_at` 設定されていない場合、結果は `created_at`基本検索では降順に、詳細検索では関連性の高い文書順に`created_at` ソートさ `created_at`れます。
`sort`	文字列です。	なし	設定可能な値は`asc` または`desc` のみです。設定されていない場合、基本検索では`created_at` の降順で、詳細検索では最も関連性の高い文書でソートされます。
`state`	文字列です。	なし	状態によるフィルタリング。`issues` および`merge_requests` スコープをサポートします。その他のスコープは無視されます。

その他のスコープは無視されます：`projects`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=projects&search=flight"

応答例

[
  {
    "id": 6,
    "description": "Nobis sed ipsam vero quod cupiditate veritatis hic.",
    "name": "Flight",
    "name_with_namespace": "Twitter / Flight",
    "path": "flight",
    "path_with_namespace": "twitter/flight",
    "created_at": "2017-09-05T07:58:01.621Z",
    "default_branch": "master",
    "tag_list":[], //deprecated, use `topics` instead
    "topics":[],
    "ssh_url_to_repo": "ssh://jarka@localhost:2222/twitter/flight.git",
    "http_url_to_repo": "http://localhost:3000/twitter/flight.git",
    "web_url": "http://localhost:3000/twitter/flight",
    "readme_url": "http://localhost:3000/twitter/flight/-/blob/master/README.md",
    "avatar_url": null,
    "star_count": 0,
    "forks_count": 0,
    "last_activity_at": "2018-01-31T09:56:30.902Z"
  }
]

その他のスコープは無視されます：`issues`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=issues&search=file"

応答例

[
  {
    "id": 83,
    "iid": 1,
    "project_id": 12,
    "title": "Add file",
    "description": "Add first file",
    "state": "opened",
    "created_at": "2018-01-24T06:02:15.514Z",
    "updated_at": "2018-02-06T12:36:23.263Z",
    "closed_at": null,
    "labels":[],
    "milestone": null,
    "assignees": [{
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    }],
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    },
    "user_notes_count": 0,
    "upvotes": 0,
    "downvotes": 0,
    "due_date": null,
    "confidential": false,
    "discussion_locked": null,
    "web_url": "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

assignee カラムは非推奨です。GitLab EE APIに準拠するため、シングルサイズの配列assignees 。

その他のスコープは無視されます：`merge_requests`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file"

応答例

[
  {
    "id": 56,
    "iid": 8,
    "project_id": 6,
    "title": "Add first file",
    "description": "This is a test MR to add file",
    "state": "opened",
    "created_at": "2018-01-22T14:21:50.830Z",
    "updated_at": "2018-02-06T12:40:33.295Z",
    "target_branch": "master",
    "source_branch": "jaja-test",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 5,
      "name": "Jacquelyn Kutch",
      "username": "abigail",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",
      "web_url": "http://localhost:3000/abigail"
    },
    "source_project_id": 6,
    "target_project_id": 6,
    "labels": [
      "ruby",
      "tests"
    ],
    "draft": false,
    "work_in_progress": false,
    "milestone": {
      "id": 13,
      "iid": 3,
      "project_id": 6,
      "title": "v2.0",
      "description": "Qui aut qui eos dolor beatae itaque tempore molestiae.",
      "state": "active",
      "created_at": "2017-09-05T07:58:29.099Z",
      "updated_at": "2017-09-05T07:58:29.099Z",
      "due_date": null,
      "start_date": null
    },
    "merge_when_pipeline_succeeds": false,
    "merge_status": "can_be_merged",
    "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b",
    "merge_commit_sha": null,
    "squash_commit_sha": null,
    "user_notes_count": 0,
    "discussion_locked": null,
    "should_remove_source_branch": null,
    "force_remove_source_branch": true,
    "web_url": "http://localhost:3000/twitter/flight/merge_requests/8",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

その他のスコープは無視されます：`milestones`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=milestones&search=release"

応答例

[
  {
    "id": 44,
    "iid": 1,
    "project_id": 12,
    "title": "next release",
    "description": "Next release milestone",
    "state": "active",
    "created_at": "2018-02-06T12:43:39.271Z",
    "updated_at": "2018-02-06T12:44:01.298Z",
    "due_date": "2018-04-18",
    "start_date": "2018-02-04"
  }
]

その他のスコープは無視されます：`snippet_titles`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample"

応答例

[
  {
    "id": 50,
    "title": "Sample file",
    "file_name": "file.rb",
    "description": "Simple ruby file",
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "updated_at": "2018-02-06T12:49:29.104Z",
    "created_at": "2017-11-28T08:20:18.071Z",
    "project_id": 9,
    "web_url": "http://localhost:3000/root/jira-test/snippets/50"
  }
]

スコープ `wiki_blobs`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye"

応答例

[
  {
    "basename": "home",
    "data": "hello\n\nand bye\n\nend",
    "path": "home.md",
    "filename": "home.md",
    "id": null,
    "ref": "master",
    "startline": 5,
    "project_id": 6,
    "group_id": null
  }
]

filename path どちらもリポジトリ内部のファイルのフルパスを返しますが、将来的にはfilename はフルパスではなくファイル名のみになる予定です。詳細はイシュー34521を参照してください。

対象範囲: コミット

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=commits&search=bye"

応答例

[
  {
  "id": "4109c2d872d5fdb1ed057400d103766aaea97f98",
  "short_id": "4109c2d8",
  "title": "goodbye $.browser",
  "created_at": "2013-02-18T22:02:54.000Z",
  "parent_ids": [
    "59d05353ab575bcc2aa958fe1782e93297de64c9"
  ],
  "message": "goodbye $.browser\n",
  "author_name": "angus croll",
  "author_email": "anguscroll@gmail.com",
  "authored_date": "2013-02-18T22:02:54.000Z",
  "committer_name": "angus croll",
  "committer_email": "anguscroll@gmail.com",
  "committed_date": "2013-02-18T22:02:54.000Z",
  "project_id": 6
  }
]

スコープ: blobs

このスコープはElasticsearchが有効な場合にのみ利用可能です。

このスコープではフィルタを使用できます：

ファイル名
パス
エクステンション

フィルタを使用するには、クエリにフィルタを含めます。例:a query filename:some_name*.

グローバル・マッチングを使用するには、ワイルドカード (*) を使用できます。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=blobs&search=installation"

応答例

[
  {
    "basename": "README",
    "data": "```\n\n## Installation\n\nQuick start using the [pre-built",
    "path": "README.md",
    "filename": "README.md",
    "id": null,
    "ref": "master",
    "startline": 46,
    "project_id": 6
  }
]

スコープ: メモ

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime"

応答例

[
  {
    "id": 191,
    "body": "Harum maxime consequuntur et et deleniti assumenda facilis.",
    "attachment": null,
    "author": {
      "id": 23,
      "name": "User 1",
      "username": "user1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/111d68d06e2d317b5a59c2c6c5bad808?s=80&d=identicon",
      "web_url": "http://localhost:3000/user1"
    },
    "created_at": "2017-09-05T08:01:32.068Z",
    "updated_at": "2017-09-05T08:01:32.068Z",
    "system": false,
    "noteable_id": 22,
    "noteable_type": "Issue",
    "project_id": 6,
    "noteable_iid": 2
  }
]

スコープ：ユーザー

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=users&search=doe"

応答例

[
  {
    "id": 1,
    "name": "John Doe1",
    "username": "user1",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
    "web_url": "http://localhost/user1"
  }
]

グループ検索 API

指定したグループ内の式を検索します。

ユーザーがグループのメンバーではなく、グループが非公開の場合、そのグループに対するGET リクエストは404 Not Found ステータスコードになります。

GET /groups/:id/search

属性	種類	必須	説明
`id`	整数または文字列。	はい	認証されたユーザーが所有するグループのID またはURL エンコードされたパス。
`scope`	文字列です。	はい	検索する範囲。値には`issues`,`merge_requests`,`milestones`,`projects`,`users`が含まれます。追加スコープ：`blobscommits`,`notes`,`wiki_blobs`.
`search`	文字列です。	はい	検索クエリ。
`confidential`	boolean	なし	守秘義務によるフィルター。`issues` 他のスコープは無視されます。
`order_by`	文字列です。	なし	`created_at` のみが `created_at`許可されます。`created_at` 設定されていない場合、結果は `created_at`基本検索では降順に、詳細検索では関連性の高い文書順に`created_at` ソートさ `created_at`れます。
`sort`	文字列です。	なし	設定可能な値は`asc` または`desc` のみです。設定されていない場合、基本検索では`created_at` の降順で、詳細検索では最も関連性の高い文書でソートされます。
`state`	文字列です。	なし	状態によるフィルタリング。`issues` および`merge_requests` のみをサポートします。その他のスコープは無視されます。

レスポンスは要求されたスコープに依存します。

その他のスコープは無視されます：`projects`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight"

応答例

[
  {
    "id": 6,
    "description": "Nobis sed ipsam vero quod cupiditate veritatis hic.",
    "name": "Flight",
    "name_with_namespace": "Twitter / Flight",
    "path": "flight",
    "path_with_namespace": "twitter/flight",
    "created_at": "2017-09-05T07:58:01.621Z",
    "default_branch": "master",
    "tag_list":[], //deprecated, use `topics` instead
    "topics":[],
    "ssh_url_to_repo": "ssh://jarka@localhost:2222/twitter/flight.git",
    "http_url_to_repo": "http://localhost:3000/twitter/flight.git",
    "web_url": "http://localhost:3000/twitter/flight",
    "readme_url": "http://localhost:3000/twitter/flight/-/blob/master/README.md",
    "avatar_url": null,
    "star_count": 0,
    "forks_count": 0,
    "last_activity_at": "2018-01-31T09:56:30.902Z"
  }
]

その他のスコープは無視されます：`issues`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file"

応答例

[
  {
    "id": 83,
    "iid": 1,
    "project_id": 12,
    "title": "Add file",
    "description": "Add first file",
    "state": "opened",
    "created_at": "2018-01-24T06:02:15.514Z",
    "updated_at": "2018-02-06T12:36:23.263Z",
    "closed_at": null,
    "labels":[],
    "milestone": null,
    "assignees": [{
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    }],
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    },
    "user_notes_count": 0,
    "upvotes": 0,
    "downvotes": 0,
    "due_date": null,
    "confidential": false,
    "discussion_locked": null,
    "web_url": "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

assignee カラムは非推奨です。GitLab EE APIに準拠するため、シングルサイズの配列assignees 。

その他のスコープは無視されます：`merge_requests`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file"

応答例

[
  {
    "id": 56,
    "iid": 8,
    "project_id": 6,
    "title": "Add first file",
    "description": "This is a test MR to add file",
    "state": "opened",
    "created_at": "2018-01-22T14:21:50.830Z",
    "updated_at": "2018-02-06T12:40:33.295Z",
    "target_branch": "master",
    "source_branch": "jaja-test",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 5,
      "name": "Jacquelyn Kutch",
      "username": "abigail",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",
      "web_url": "http://localhost:3000/abigail"
    },
    "source_project_id": 6,
    "target_project_id": 6,
    "labels": [
      "ruby",
      "tests"
    ],
    "draft": false,
    "work_in_progress": false,
    "milestone": {
      "id": 13,
      "iid": 3,
      "project_id": 6,
      "title": "v2.0",
      "description": "Qui aut qui eos dolor beatae itaque tempore molestiae.",
      "state": "active",
      "created_at": "2017-09-05T07:58:29.099Z",
      "updated_at": "2017-09-05T07:58:29.099Z",
      "due_date": null,
      "start_date": null
    },
    "merge_when_pipeline_succeeds": false,
    "merge_status": "can_be_merged",
    "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b",
    "merge_commit_sha": null,
    "squash_commit_sha": null,
    "user_notes_count": 0,
    "discussion_locked": null,
    "should_remove_source_branch": null,
    "force_remove_source_branch": true,
    "web_url": "http://localhost:3000/twitter/flight/merge_requests/8",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

その他のスコープは無視されます：`milestones`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release"

応答例

[
  {
    "id": 44,
    "iid": 1,
    "project_id": 12,
    "title": "next release",
    "description": "Next release milestone",
    "state": "active",
    "created_at": "2018-02-06T12:43:39.271Z",
    "updated_at": "2018-02-06T12:44:01.298Z",
    "due_date": "2018-04-18",
    "start_date": "2018-02-04"
  }
]

スコープ `wiki_blobs`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye"

応答例

[
  {
    "basename": "home",
    "data": "hello\n\nand bye\n\nend",
    "path": "home.md",
    "filename": "home.md",
    "id": null,
    "ref": "master",
    "startline": 5,
    "project_id": 6,
    "group_id": 1
  }
]

スコープ `commits`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye"

応答例

[
  {
  "id": "4109c2d872d5fdb1ed057400d103766aaea97f98",
  "short_id": "4109c2d8",
  "title": "goodbye $.browser",
  "created_at": "2013-02-18T22:02:54.000Z",
  "parent_ids": [
    "59d05353ab575bcc2aa958fe1782e93297de64c9"
  ],
  "message": "goodbye $.browser\n",
  "author_name": "angus croll",
  "author_email": "anguscroll@gmail.com",
  "authored_date": "2013-02-18T22:02:54.000Z",
  "committer_name": "angus croll",
  "committer_email": "anguscroll@gmail.com",
  "committed_date": "2013-02-18T22:02:54.000Z",
  "project_id": 6
  }
]

スコープ `blobs`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

このスコープではフィルタを使用できます：

ファイル名
パス
エクステンション

フィルタを使用するには、クエリにフィルタを含めます。例:a query filename:some_name*.

グローバル・マッチングを使用するには、ワイルドカード (*) を使用できます。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation"

応答例

[
  {
    "basename": "README",
    "data": "```\n\n## Installation\n\nQuick start using the [pre-built",
    "path": "README.md",
    "filename": "README.md",
    "id": null,
    "ref": "master",
    "startline": 46,
    "project_id": 6
  }
]

スコープ `notes`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime"

応答例

[
  {
    "id": 191,
    "body": "Harum maxime consequuntur et et deleniti assumenda facilis.",
    "attachment": null,
    "author": {
      "id": 23,
      "name": "User 1",
      "username": "user1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/111d68d06e2d317b5a59c2c6c5bad808?s=80&d=identicon",
      "web_url": "http://localhost:3000/user1"
    },
    "created_at": "2017-09-05T08:01:32.068Z",
    "updated_at": "2017-09-05T08:01:32.068Z",
    "system": false,
    "noteable_id": 22,
    "noteable_type": "Issue",
    "project_id": 6,
    "noteable_iid": 2
  }
]

その他のスコープは無視されます：`users`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe"

応答例

[
  {
    "id": 1,
    "name": "John Doe1",
    "username": "user1",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
    "web_url": "http://localhost/user1"
  }
]

プロジェクト検索 API

指定したプロジェクト内の式を検索します。

ユーザーがプロジェクトのメンバーではなく、プロジェクトが非公開である場合、そのプロジェクトに対するGET リクエストは404 ステータスコードになります。

GET /projects/:id/search

属性	種類	必須	説明
`id`	整数または文字列。	はい	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス。
`scope`	文字列です。	はい	検索するスコープ。値には`blobs`,`commits`,`issues`,`merge_requests`,`milestones`,`notes`,`users`,`wiki_blobs`が含まれます。
`search`	文字列です。	はい	検索クエリ。
`confidential`	boolean	なし	守秘義務によるフィルタリング。`issues` スコープをサポートします。他のスコープは無視されます。
`ref`	文字列です。	なし	検索するリポジトリのブランチまたはタグの名前。デフォルトではプロジェクトのデフォルトブランチが使用されます。スコープ`blobs`,`commits`,`wiki_blobs` にのみ適用可能です。
`order_by`	文字列です。	なし	`created_at` のみが `created_at`許可されます。`created_at` 設定されていない場合、結果は `created_at`基本検索では降順に、詳細検索では関連性の高い文書順に`created_at` ソートさ `created_at`れます。
`sort`	文字列です。	なし	設定可能な値は`asc` または`desc` のみです。設定されていない場合、基本検索では`created_at` の降順で、詳細検索では最も関連性の高い文書でソートされます。
`state`	文字列です。	なし	状態によるフィルタリング。`issues` および`merge_requests` スコープをサポートします。その他のスコープは無視されます。

レスポンスは要求されたスコープに依存します。

その他のスコープは無視されます：`issues`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file"

応答例

[
  {
    "id": 83,
    "iid": 1,
    "project_id": 12,
    "title": "Add file",
    "description": "Add first file",
    "state": "opened",
    "created_at": "2018-01-24T06:02:15.514Z",
    "updated_at": "2018-02-06T12:36:23.263Z",
    "closed_at": null,
    "labels":[],
    "milestone": null,
    "assignees": [{
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    }],
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 20,
      "name": "Ceola Deckow",
      "username": "sammy.collier",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/c23d85a4f50e0ea76ab739156c639231?s=80&d=identicon",
      "web_url": "http://localhost:3000/sammy.collier"
    },
    "user_notes_count": 0,
    "upvotes": 0,
    "downvotes": 0,
    "due_date": null,
    "confidential": false,
    "discussion_locked": null,
    "web_url": "http://localhost:3000/h5bp/7bp/subgroup-prj/issues/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

assignee カラムは非推奨です。GitLab EE APIに準拠するため、シングルサイズの配列assignees 。

その他のスコープは無視されます：`merge_requests`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file"

応答例

[
  {
    "id": 56,
    "iid": 8,
    "project_id": 6,
    "title": "Add first file",
    "description": "This is a test MR to add file",
    "state": "opened",
    "created_at": "2018-01-22T14:21:50.830Z",
    "updated_at": "2018-02-06T12:40:33.295Z",
    "target_branch": "master",
    "source_branch": "jaja-test",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "assignee": {
      "id": 5,
      "name": "Jacquelyn Kutch",
      "username": "abigail",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/3138c66095ee4bd11a508c2f7f7772da?s=80&d=identicon",
      "web_url": "http://localhost:3000/abigail"
    },
    "source_project_id": 6,
    "target_project_id": 6,
    "labels": [
      "ruby",
      "tests"
    ],
    "draft": false,
    "work_in_progress": false,
    "milestone": {
      "id": 13,
      "iid": 3,
      "project_id": 6,
      "title": "v2.0",
      "description": "Qui aut qui eos dolor beatae itaque tempore molestiae.",
      "state": "active",
      "created_at": "2017-09-05T07:58:29.099Z",
      "updated_at": "2017-09-05T07:58:29.099Z",
      "due_date": null,
      "start_date": null
    },
    "merge_when_pipeline_succeeds": false,
    "merge_status": "can_be_merged",
    "sha": "78765a2d5e0a43585945c58e61ba2f822e4d090b",
    "merge_commit_sha": null,
    "squash_commit_sha": null,
    "user_notes_count": 0,
    "discussion_locked": null,
    "should_remove_source_branch": null,
    "force_remove_source_branch": true,
    "web_url": "http://localhost:3000/twitter/flight/merge_requests/8",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]

その他のスコープは無視されます：`milestones`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release"

応答例

[
  {
    "id": 44,
    "iid": 1,
    "project_id": 12,
    "title": "next release",
    "description": "Next release milestone",
    "state": "active",
    "created_at": "2018-02-06T12:43:39.271Z",
    "updated_at": "2018-02-06T12:44:01.298Z",
    "due_date": "2018-04-18",
    "start_date": "2018-02-04"
  }
]

スコープ `notes`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime"

応答例

[
  {
    "id": 191,
    "body": "Harum maxime consequuntur et et deleniti assumenda facilis.",
    "attachment": null,
    "author": {
      "id": 23,
      "name": "User 1",
      "username": "user1",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/111d68d06e2d317b5a59c2c6c5bad808?s=80&d=identicon",
      "web_url": "http://localhost:3000/user1"
    },
    "created_at": "2017-09-05T08:01:32.068Z",
    "updated_at": "2017-09-05T08:01:32.068Z",
    "system": false,
    "noteable_id": 22,
    "noteable_type": "Issue",
    "project_id": 6,
    "noteable_iid": 2
  }
]

スコープ `wiki_blobs`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

このスコープではフィルタを使用できます：

ファイル名
パス
エクステンション

フィルタを使用するには、クエリにフィルタを含めます。例：a query filename:some_name* 。グロブ・マッチングを使用するには、ワイルドカード (*) を使用できます。

Wiki blobs検索はファイル名とコンテンツの両方に対して実行されます。検索結果

ファイル名で検索された結果は、コンテンツで検索された結果の前に表示されます。
検索文字列がファイル名とコンテンツの両方で見つかったり、コンテンツで複数回見つかったりするため、同じblobに複数のマッチが含まれることがあります。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye"

応答例

[
  {
    "basename": "home",
    "data": "hello\n\nand bye\n\nend",
    "path": "home.md",
    "filename": "home.md",
    "id": null,
    "ref": "master",
    "startline": 5,
    "project_id": 6,
    "group_id": 1
  }
]

スコープ `commits`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye"

応答例

[
  {
  "id": "4109c2d872d5fdb1ed057400d103766aaea97f98",
  "short_id": "4109c2d8",
  "title": "goodbye $.browser",
  "created_at": "2013-02-18T22:02:54.000Z",
  "parent_ids": [
    "59d05353ab575bcc2aa958fe1782e93297de64c9"
  ],
  "message": "goodbye $.browser\n",
  "author_name": "angus croll",
  "author_email": "anguscroll@gmail.com",
  "authored_date": "2013-02-18T22:02:54.000Z",
  "committer_name": "angus croll",
  "committer_email": "anguscroll@gmail.com",
  "committed_date": "2013-02-18T22:02:54.000Z",
  "project_id": 6
  }
]

スコープ `blobs`

このスコープはElasticsearchが有効な場合にのみ利用可能です。

このスコープではフィルタを使用できます：

ファイル名
経路
エクステンション

ブロブ検索は、ファイル名とコンテンツの両方に対して実行されます。検索結果は以下のとおりです：

ファイル名で検索された結果は、コンテンツで検索された結果の前に表示されます。
検索文字列がファイル名とコンテンツの両方で見つかったり、コンテンツで複数回見つかったりするため、同じblobに複数のマッチが含まれることがあります。

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=keyword%20filename:*.py

応答例

[
  {
    "basename": "README",
    "data": "```\n\n## Installation\n\nQuick start using the [pre-built",
    "path": "README.md",
    "filename": "README.md",
    "id": null,
    "ref": "master",
    "startline": 46,
    "project_id": 6
  }
]

その他のスコープは無視されます：`users`

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe"

応答例

[
  {
    "id": 1,
    "name": "John Doe1",
    "username": "user1",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
    "web_url": "http://localhost/user1"
  }
]

検索API

追加スコープ

高度な検索 API

その他のスコープは無視されます：`projects`

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

その他のスコープは無視されます：`snippet_titles`

スコープ `wiki_blobs`

対象範囲: コミット

スコープ: blobs

スコープ: メモ

スコープ：ユーザー

グループ検索 API

その他のスコープは無視されます：`projects`

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

スコープ `wiki_blobs`

スコープ `commits`

スコープ `blobs`

スコープ `notes`

その他のスコープは無視されます：`users`

プロジェクト検索 API

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

スコープ `notes`

スコープ `wiki_blobs`

スコープ `commits`

スコープ `blobs`

その他のスコープは無視されます：`users`

Help & feedback

Docs

Product

Feature availability and product trials

Get Help

検索API

追加スコープ

高度な検索 API

その他のスコープは無視されます：projects

その他のスコープは無視されます：issues

その他のスコープは無視されます：merge_requests

その他のスコープは無視されます：milestones

その他のスコープは無視されます：snippet_titles

スコープ wiki_blobs

対象範囲: コミット

スコープ: blobs

スコープ: メモ

スコープ：ユーザー

グループ検索 API

その他のスコープは無視されます：projects

その他のスコープは無視されます：issues

その他のスコープは無視されます：merge_requests

その他のスコープは無視されます：milestones

スコープ wiki_blobs

スコープ commits

スコープ blobs

スコープ notes

その他のスコープは無視されます：users

プロジェクト検索 API

その他のスコープは無視されます：issues

その他のスコープは無視されます：merge_requests

その他のスコープは無視されます：milestones

スコープ notes

スコープ wiki_blobs

スコープ commits

スコープ blobs

その他のスコープは無視されます：users

Help & feedback

Docs

Product

Feature availability and product trials

Get Help

その他のスコープは無視されます：`projects`

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

その他のスコープは無視されます：`snippet_titles`

スコープ `wiki_blobs`

その他のスコープは無視されます：`projects`

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

スコープ `wiki_blobs`

スコープ `commits`

スコープ `blobs`

スコープ `notes`

その他のスコープは無視されます：`users`

その他のスコープは無視されます：`issues`

その他のスコープは無視されます：`merge_requests`

その他のスコープは無視されます：`milestones`

スコープ `notes`

スコープ `wiki_blobs`

スコープ `commits`

スコープ `blobs`

その他のスコープは無視されます：`users`