services リソース

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018. All 1.0 APIs will be removed from the REST API permanently on 12 April 2019. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

概要

Bitbucket は、特定のイベントに対応して実行される一連のブローカー を経由して、外部サービス (hook) と連携します。ブローカーは、イベントの情報を受け取って 1 つ以上のアクションを実行する Python スクリプトです。たとえば、Bamboo と連携するための Bamboo ブローカーがあります。Bitbucket チームはさまざまなブローカーを開発しています。サードパーティ ベンダーも、複数のブローカーを開発しています。

The Bitbucket services resource provides functionality for adding, removing, and configuring brokers on your repositories.  All the methods on this resource require the caller to authenticate.  Services have the following structure:

{
        "id": 190807,
        "service": {
            "fields": [
                {
                    "name": "Password",
                    "value": ""
                },
                {
                    "name": "Username",
                    "value": ""
                },
                {
                    "name": "Discussion URL",
                    "value": ""
                }
            ],
            "type": "Basecamp"
        }
    }

services 構造のフィールドは次のとおりです。

フィールド 説明
id サービスの一意の ID を表す、Bitbucket によって割り当てられた整数。
service サービスを説明するプロファイル。

fields A parameter array containing a name and value pair for each parameter associated with the service.

type One of the supported services. The type is a case-insensitive value.

次のサービスがサポートされます。

名前 説明とパラメータ
POST Bitbucket は、指定されたサービス URL への POST を行います。ユーザーがリポジトリへのプッシュを行うと、サービスは POST を受け取ります。
URL
Bitbucket の更新メッセージの送信先の URL。
FogBugz バグ トラッキング サービス。このサービスには次のパラメータがあります。
Repository ID
FogBugz リポジトリの ID。
CVSSubmit URL
Bitbucket の更新メッセージの送信先の URL を入力します。
Basecamp
Web ベースのプロジェクト管理アプリケーション。
パスワード
Basecamp のパスワード。
Discussion URL
Bitbucket の更新メッセージの送信先の URL を入力します。
ユーザ名
Basecamp のユーザー名。
Lighthouse
シンプルな課題トラッキング システム。
プロジェクト ID
Enter the numeric ID for your project. You can get it from your project URL at Lighthouse.
For example, let's say your Lighthouse project URL is this: 
XXXXX.lighthouseapp.com/projects/00000-yourproject/overview
In this case,  00000  would be your Project ID.
API キー
Lighthouse で作成した API トークン (前述) を入力します。
Subdomain
The Lighthouse account name.
For example, let's say your Lighthouse project URL is this: 
XXXXX.lighthouseapp.com/projects/00000-yourproject/overview
In this case, XXXXX  would be your subdomain.
課題
ユーザーがコミット メッセージから Bitbucket の課題トラッカーの課題を参照できます。Bitbucket では 2012 年 8 月より後に新しく作成された課題トラッカーに対してこのサービスが自動的に適用されます。このサービスにはパラメータはありません。
メール アドレス
プッシュされたチェンジグループそれぞれについて、指定されたメール アドレスにメール メッセージを送信することを Bitbucket に許可します。
メール アドレス 送信先のメール アドレス。
diff
リポジトリが更新されたときに指定したメール アドレスにメール メッセージを送信するよう Bitbucket をセットアップします。
メール アドレス
Bitbucket がメール メッセージを送信するメール アドレス。
Rietveld

 
コード レビュー ツール。
メール アドレス

The URL of your Rietveld site. The default value is: http://reitveld-bitbucket.appspot.com/

パスワード
Rietveld のユーザー パスワード。
URL
Rietveld のメール アドレス。
Superfeeder
Superfeeds はリアルタイムのフィード パース クラウド サービスです。このサービスではパラメータは不要です。
Geocommit
Geocommit はコミットに位置情報を追加するサービスです。
Pivotal Tracker
アジャイル プロジェクト管理ツール。
Token
トラッカーはトークン方式を使用して API ユーザーの認証を行い、プロジェクトでのユーザーのメンバーシップに応じてプロジェクトおよびストーリーへのアクセス制御を行います。トークンを生成するには、My Profile ページで [Create New Token] リンクを使用します。
Twitter
Twitter サービスを API 経由で追加できますが、three-legged OAuth 認証が必要になるため、GUI での構成が必要です。詳細については「Twitter サービスの管理」をご参照ください。
シークレット
Twitter が生成した秘密キー。
Token
Twitter が生成したトークン。
形式
Twitter の更新形式。


リポジトリのサービス一覧の取得

リポジトリに存在するサービスの一覧を取得します。

GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/services
ここをクリックして展開...
[
    {
        "id": 3,
        "service": {
            "fields": [
                {
                    "name": "Email",
                    "value": "mcatalbas@atlassian.com"
                }
            ],
            "type": "Email"
        }
    },
    {
        "id": 4,
        "service": {
            "fields": [
                {
                    "name": "URL",
                    "value": "http://example.com/post"
                }
            ],
            "type": "POST"
        }
    }
]

リポジトリに設定された 1 つのサービスの取得

リポジトリに設定された 1 つのサービスのプロファイルを返します。この呼び出しを使用するにはサービス ID を取得している必要があります。

GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/services/{id}
ここをクリックして展開...
[
    {
        "id": 4,
        "service": {
            "fields": [
                {
                    "name": "URL",
                    "value": "http://example.com/post"
                }
            ],
            "type": "POST"
        }
    }
]


新しいサービスの投稿

Adds a service to a repository. Only the type of the service is required in the POST data. (Service type is a case-insensitive match.)  Optionally, you can provide all the service parameters.  You can update service fields later.  For example, the following shows a call to create a POST service:

curl -u tutorials:8798987 -X POST https://api.bitbucket.org/1.0/repositories/tutorials/testrepo/services/-d "type=POST&URL=https%3A%2F%2Fbitbucket.org/post"
POST https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/services/ --data "type=value&parameter=value&..."
ここをクリックして展開...
{
    "id": 5,
    "service": {
        "fields": [
            {
                "name": "URL",
                "value": "https://bitbucket.org/post"
            }
        ],
        "type": "POST"
    }
}

 

サービスへの変更の投稿

To update a service, issue a PUT request with the id of the repository service included in the URL.  Pass each parameter separately.  You must include all the parameters in the service.  If you omit a parameter or pass an invalid parameter, the PUT removes all the values for the service.

例:

$ curl --request PUT --user mcatalbas:password https://api.bitbucket.org/1.0/repositories/mcatalbas/test/services/5/--data "URL=https://bitbucket.org/new_post"
PUT https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/services/{id} --data "parameter=value"  --data "parameter=value" ...
ここをクリックして展開...
{
    "id": 5,
    "service": {
        "fields": [
            {
                "name": "URL",
                "value": "https://bitbucket.org/new_post"
            }
        ],
        "type": "POST"
    }
}


サービスの削除

Removes a service. The caller must supply the id of the service to remove for example:

$ curl --request DELETE --user mcatalbas:password https://api.bitbucket.org/1.0/repositories/mcatalbas/test/services/5/.
最終更新日 2018 年 6 月 14 日

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

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