repository リソース 1.0

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API バージョン 1 は 2018 年 6 月 30 日に廃止予定です。すべての 1.0 API は、2019 年 4 月 29 日に、REST API から完全に削除されます。廃止についての告知をご確認ください。また、バージョン 2.0 の REST API ドキュメントをご確認ください。

概要

For the repository resource, you supply a  repo_slug that identifies the specific repository.  For example, the repo_slug for this repository  https://bitbucket.org/tortoisehg/thg   is thg.  You can use this resource to create a new repository or edit a specific one. There are several URLs that allow you to query for branch resources. Unauthenticated calls for this resource only return values for public repositories.

非公開リポジトリを表示するには、リポジトリで少なくとも読み取り権限を持っている必要があります。

新しいリポジトリの作成 廃止予定

認証しているユーザーのアカウントの配下に新しいリポジトリを作成します。アカウントが自動的にリポジトリのオーナーになります。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
name はい リポジトリの名前。
description いいえ リポジトリの説明。
scm いいえ A value of git or hg. The default is git if you leave this parameter unspecified.
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ Boolean specifying if the repository is private (true) or public (false).  The default is false.
https://api.bitbucket.org/1.0/repositories --data "name=mynewrepo"
正常時に返されるデータを表示するにはここをクリック...
{
    "scm": "git",
    "has_wiki": false,
    "last_updated": "2012-10-09 22:34:47",
    "creator": null,
    "forks_count": 0,
    "created_on": "2012-10-09 22:34:47",
    "owner": "tutorials",
    "logo": null,
    "email_mailinglist": "",
    "is_mq": false,
    "size": 0,
    "read_only": false,
    "fork_of": null,
    "mq_of": null,
    "followers_count": 1,
    "state": "creating",
    "utc_created_on": "2012-10-09 20:34:47+00:00",
    "website": "",
    "description": "",
    "has_issues": false,
    "is_fork": false,
    "slug": "test5003",
    "is_private": true,
    "name": "mynewrepo",
    "language": "",
    "utc_last_updated": "2012-10-09 20:34:47+00:00",
    "email_writers": true,
    "no_public_forks": false,
    "resource_uri": "/1.0/repositories/tutorials/test5003"
}

新しいフォークの追加

認証しているユーザーのアカウントの配下で新しくリポジトリをフォークします。アカウントが自動的にリポジトリのオーナーになります。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
name はい リポジトリの名前。
description いいえ リポジトリの説明。
scm Ignored この値を指定できますが、システムによって無視されます。
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ Boolean specifying if the repository is private (true) or public (false).  The default is false.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/fork --data "name=mynewrepo"
正常時に返されるデータを表示するにはここをクリック...
{
  "scm": "hg",
  "has_wiki": false,
  "last_updated": "2013-01-29 19:36:47",
  "creator": null,
  "created_on": "2013-01-29 19:36:47",
  "owner": "auserbb",
  "logo": "https://d3oaxc4q5k2d6q.cloudfront.net/m/f2d828db6961/img/language-avatars/html5_16.png",
  "email_mailinglist": "",
  "is_mq": false,
  "size": 0,
  "read_only": false,
  "fork_of": {
    "scm": "hg",
    "has_wiki": true,
    "last_updated": "2013-01-29 18:44:43",
    "creator": null,
    "created_on": "2011-12-20 17:35:06",
    "owner": "tutorials",
    "logo": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2012/Nov/28/tutorials.bitbucket.org-logo-1456883302-9_avatar.png",
    "email_mailinglist": "\ndocs@bitbucket.org",
    "is_mq": false,
    "size": 33473378,
    "read_only": false,
    "fork_of": null,
    "mq_of": null,
    "followers_count": 4,
    "state": "available",
    "utc_created_on": "2011-12-20 16:35:06+00:00",
    "website": "",
    "description": "Site for tutorial101 files",
    "has_issues": true,
    "is_fork": false,
    "slug": "tutorials.bitbucket.org",
    "is_private": false,
    "name": "tutorials.bitbucket.org",
    "language": "html/css",
    "utc_last_updated": "2013-01-29 17:44:43+00:00",
    "email_writers": true,
    "no_public_forks": false,
    "resource_uri": "/1.0/repositories/tutorials/tutorials.bitbucket.org"
  },
  "mq_of": null,
  "followers_count": 0,
  "state": "creating",
  "utc_created_on": "2013-01-29 18:36:47+00:00",
  "website": null,
  "description": "this is a a long description",
  "has_issues": false,
  "is_fork": true,
  "slug": "tryitagainagain",
  "is_private": true,
  "name": "tryitagainagain",
  "language": "html/css",
  "utc_last_updated": "2013-01-29 18:36:47+00:00",
  "email_writers": true,

リポジトリの更新

既存のリポジトリを更新します。呼び出し元は、アカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい The accountname of the repo owner.
repo_slug はい リポジトリのスラッグ。
name いいえ ユーザーに表示されるリポジトリ名。
description いいえ リポジトリの説明。
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ Boolean specifying if the repository is private (true) or public (false).  The default is true.
landing_page いいえ ユーザーがリポジトリの URL にアクセスした場合に表示する既定ページ。
website いいえ リポジトリに関連する Web サイト。例として、企業の Web サイトがあります。
main_branch いいえ リポジトリのメイン ブランチ。
analytics_key いいえ トラッキング用の Google Analytics キー。これは Google から取得します。
akismet_key いいえ 課題トラッカーでのスパムを軽減するための Akismet キー。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}--data "description=long description"
ここをクリックして展開...
{
  "scm": "git",
  "has_wiki": false,
  "last_updated": "2013-10-10T02:06:48.181",
  "no_forks": false,
  "forks_count": 0,
  "created_on": "2013-08-22T01:37:50.135",
  "owner": "tutorials",
  "logo": "https://d3oaxc4q5k2d6q.cloudfront.net/m/95a419471117/img/language-avatars/default_16.png",
  "email_mailinglist": "",
  "is_mq": false,
  "size": 19054,
  "read_only": false,
  "fork_of": null,
  "mq_of": null,
  "state": "available",
  "utc_created_on": "2013-08-21 23:37:50+00:00",
  "website": "",
  "description": "A sample code project",
  "has_issues": false,
  "is_fork": false,
  "slug": "samplecode",
  "is_private": false,
  "name": "samplecode",
  "language": "",
  "utc_last_updated": "2013-10-10 00:06:48+00:00",
  "email_writers": true,
  "no_public_forks": false,
  "creator": null,
  "resource_uri": "/1.0/repositories/tutorials/samplecode"

既存のリポジトリの削除 廃止予定

リポジトリを削除します。呼び出し元はリポジトリのオーナーとして認証している必要があります。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい リポジトリ オーナー。
repo_slug はい そのアカウントに所属しているリポジトリ。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}

Returns HTTP/1.1 204 NO CONTENT when successful.

ブランチの一覧の取得

リポジトリに関連付けられたブランチの一覧を取得します。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/branches
正常時に返されるデータを表示するにはここをクリック...
{
    "master": {
        "node": "0b64d6000dad",
        "files": [
            {
                "type": "modified",
                "file": "atlassian-docco-cli/pom.xml"
            },
            {
                "type": "modified",
                "file": "atlassian-docco-maven/pom.xml"
            },
            {
                "type": "modified",
                "file": "atlassian-docco/pom.xml"
            },
            {
                "type": "modified",
                "file": "pom.xml"
            }
        ],
        "raw_author": "Jonathan Doklovic <doklovic@atlassian.com>",
        "utctimestamp": "2012-05-07 22:35:02+00:00",
        "author": "doklovic_atlassian",
        "timestamp": "2012-05-08 00:35:02",
        "raw_node": "0b64d6000dad15bb8cc520d4cc6da7a6bf2c5b99",
        "parents": [
            "94aff5071793"
        ],
        "branch": "master",
        "message": "[maven-release-plugin] prepare for next development iteration\n",
        "revision": null,
        "size": -1
    }
}

リポジトリのメイン ブランチの取得

リポジトリに関連付けられたメイン ブランチを取得します。リポジトリのメイン ブランチは、リポジトリの [リポジトリ詳細] ページで設定します。

このメソッドは次のパラメーターをサポートしています。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/main-branch
正常時に返されるデータを表示するにはここをクリック...

メイン ブランチが設定されている場合、ブランチ名が返されます。

{
    "name": "master"
}

メイン ブランチが設定されていない場合、次の情報が返されます。

No main branch set.

ブランチのタグの一覧の取得

リポジトリのブランチと関連付けられたタグの一覧を取得します。

このメソッドは次のパラメーターをサポートしています。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/branches-tags
正常時に返されるデータを表示するにはここをクリック...
{
    "branches": [{
        "changeset": "a2e42cc621de6f596687389b8a9bed7f476b1007",
        "heads": ["a2e42cc621de6f596687389b8a9bed7f476b1007"],
        "name": "bb101repo-branch",
        "mainbranch": false
    }, {
        "changeset": "9ccfbab51780e0ca31e2738e1b91f5efa0bb46d0",
        "heads": ["9ccfbab51780e0ca31e2738e1b91f5efa0bb46d0"],
        "name": "master",
        "mainbranch": true
    }],
    "tags": [{
        "changeset": "a2e42cc621de6f596687389b8a9bed7f476b1007",
        "name": "bb101repo-branch"
    }]
}

リポジトリのマニフェストの取得

リビジョン用にリポジトリのマニフェストを取得します。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
revision はい A revision to get such as default or master.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/{revision}
正常時に返されるデータを表示するにはここをクリック...
{
    "Readme": "cfed61d1bfe1",
    "index.html": "2151785dae36"
}

タグの一覧の取得

このリソースを使用すると、指定したリポジトリのタグとブランチの一覧を取得できます。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/tags
正常時に返されるデータを表示するにはここをクリック...
{
    "tip": {
        "node": "562344e0ae10",
        "files": [
            {
                "type": "modified",
                "file": "index.html"
            }
        ],
        "raw_author": "Stephen Imhoff <clockwork-muse@hotmail.com>",
        "utctimestamp": "2012-08-12 02:06:43+00:00",
        "author": "clockwork_muse",
        "timestamp": "2012-08-12 04:06:43",
        "raw_node": "562344e0ae1016dee08679d84d687a8a6615d230",
        "parents": [
            "101f16a95c13"
        ],
        "branch": "default",
        "message": "Add tutorial quote.",
        "revision": 1185,
        "size": -1
    }
}

元のソースの取得

このリソースを使用すると、ファイルまたはディレクトリの元のコンテンツまたはファイルを取得できます。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
revision  Yes 一覧を作成するリビジョンまたはブランチを指定する値。
path はい  The path can be a filename or a directory path. If path ends with / it is interpreted as a directory and returns a list.

次の呼び出しはディレクトリのコンテンツを取得します。

-v https://api.bitbucket.org/1.0/repositories/tutorials/tutorials.bitbucket.org/raw/default/images

Returns the content of the images directory which resides at the top of the default revision. This call shows the contents of the index.html file.

-v https://api.bitbucket.org/1.0/repositories/tutorials/tutorials.bitbucket.org/raw/default/index.html

The path is case sensitive so index.html is not the same as an Index.html file. Private repositories require the caller to authenticate as a user with access to the repository.

https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/raw/{revision}/{path}

Successful calls return HTTP/1.1 200 OK.

ファイルの履歴をチェンジセットで取得

指定したチェンジセット以降のファイルの履歴を返します。このメソッドでは次のパラメータを使用できます。

パラメータ 必須かどうか 説明
accountname はい チームまたは個人のアカウント。
repo_slug はい そのアカウントに所属しているリポジトリ。
node はい チェンジセットのノード ID。
path はい ファイル名。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/filehistory/{node}/{path}
正常時に返されるデータを表示するにはここをクリック...
  {
    "node": "1b8a451e04ec",
    "files": [
      {
        "type": "added",
        "file": "onlyhere.txt"
      }
    ],
    "raw_author": "Mary Anthony <manthony@atlassian.com>",
    "utctimestamp": "2012-11-11T05:27:13+00:00",
    "author": {
      "username": "restbrowser",
      "first_name": "Mary",
      "last_name": "Anthony",
      "is_team": false,
      "avatar": "https://secure.gravatar.com/avatar/e4ddd9b26ff93faf679d5b1aba114a04?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F86a3f7769fd5%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32",
      "resource_uri": "/1.0/users/restbrowser"
    },
    "timestamp": "2012-11-11 06:27:13",
    "raw_node": "1b8a451e04ec8e313da63d57327e88ca314d5aaf",
    "parents": [
      "34a84046efa8"
    ],
    "branch": "feature",
    "message": "adding only to this branch\n",
    "revision": null,
    "size": -1
  }
]
最終更新日 2018 年 6 月 14 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.