links リソース

お困りですか?

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

コミュニティに質問

Bitbucket Cloud v1 API は廃止予定です

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

概要

Links connect your commit messages and code comments directly to your Jira issue tracker or Bamboo build server. You can also create custom link resources. The links resource supplies functionality for adding, updating, removing, and viewing links associated with your repositories. Links have the following fields:

フィールド 説明
id Bitbucket によって割り当てられた一意の識別子。
handler

次のハンドラー タイプのいずれかを表すプロファイル。

  • Jira
  • Bamboo
  • Cruicible
  • Jenkins
  • カスタム

ハンドラー プロファイルのコンテンツは、ハンドラーが既知のタイプかカスタム タイプかによって異なります。既知のタイプのハンドラーには次のフィールドがあります。

フィールド 説明
url サービスの場所。":" で開始される場合があります。
display_from \1、\2、などのシンタックスを使用し、キャプチャ グループへの参照を含めます。
name ハンドラー名。
key A value identifying the project on the specified url.
display_to A value created by the Bitbucket service from the url.

A custom handler has the following fields:

フィールド 説明
display_to サービスの表示名。
replacement_url \1、\2、などのシンタックスを使用し、キャプチャ グループへの参照を含めます。
raw_regex リンク URL で使用するキャプチャ グループを含みます。
name ハンドラー名。
display_from 表示 URL。

The DVCS connector creates a custom handler.

リポジトリに関連付けられたリンクを含む配列を取得します。呼び出し元はリポジトリへの管理アクセス権限を持つユーザーとして認証する必要があります。呼び出し元は、次のパラメーターを指定できます。

パラメータ

必須かどうか

説明

accountname はい リポジトリを所有しているチームまたは個人アカウント。
repo_slug はい リポジトリ ID。
ここをクリックして展開...
[
    {
        "handler": {
            "display_to": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse/\\1",
            "replacement_url": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse/\\1",
            "raw_regex": "(?<!\\w)([A-Z|a-z]{2,}-\\d+)(?!\\w)",
            "name": "custom",
            "display_from": "Custom ((?<!\\w)([A-Z|a-z]{2,}-\\d+)(?!\\w))"
        },
        "id": 25991
    },
    {
        "handler": {
            "url": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse",
            "display_from": "JIRA (PROJ)",
            "name": "jira",
            "key": "PROJ",
            "display_to": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse"
        },
        "id": 34053
    }
]

リポジトリの個々のリンクを取得します。呼び出し元はリポジトリへの管理アクセス権限を持つユーザーとして認証する必要があります。呼び出し元は、次のパラメーターを指定できます。

パラメータ

必須かどうか

説明

accountname はい リポジトリを所有しているチームまたは個人アカウント。
repo_slug はい リポジトリ ID。
object_id はい リンク ID。
GET https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/links/{object_id}
ここをクリックして展開...
{
        "handler": {
            "display_to": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse/\\1",
            "replacement_url": "http://172-28-13-105.staff.sf.atlassian.com:2990/jira/browse/\\1",
            "raw_regex": "(?<!\\w)([A-Z|a-z]{2,}-\\d+)(?!\\w)",
            "name": "custom",
            "display_from": "Custom ((?<!\\w)([A-Z|a-z]{2,}-\\d+)(?!\\w))"
        },
       "id": 25991
}

リポジトリで新しいリンクを作成します。次のパラメーターがサポートされます。

パラメータ 必須 説明
handler はい

ハンドラー パラメーターで有効な値は次のとおりです。

  • jira
  • bamboo
  • crucible
  • jenkins
  • custom
accountname はい リポジトリを所有しているチームまたは個人アカウント。
repo_slug はい リポジトリ ID。
link_url はい http または https で開始する有効な URL。このパラメーターは、アプリケーションが存在する URL を示します。この値は、すべてのリポジトリ リンクを通じて一意である必要があります。
link_key はい

空ではない文字列。このパラメーターは、リンク先のプロジェクト キーです。例えば、Jira にリンクしようとしていて、プロジェクト キーが MYPROJ の場合、値は MYPROJ になります。

カスタム リンクを作成する場合、この値にはキーと一致する正規表現が含まれます。

呼び出し元はリポジトリへの管理アクセス権限を持つユーザーとして認証する必要があります。

ここをクリックして展開...
$ curl --request POST --user mcatalbas:password 'https://bitbucket.org/!api/1.0/repositories/bitbucket/staging/links/' 
{
    "handler": {
        "url": "http://yourjira.com/",
        "display_from": "JIRA (PROJ)",
        "name": "jira",
        "key": "PROJ",
        "display_to": "http://yourjira.com/"
    },
    "id": 87
}


リポジトリ リンクを更新します。次のパラメーターがサポートされます。

パラメータ 必須かどうか 説明
link_url はい http または https で開始する有効な URL。このパラメーターは、アプリケーションが存在する URL を示します。この値は、すべてのリポジトリ リンクを通じて一意である必要があります。
link_key はい 空ではない文字列。このパラメーターは、リンク先のプロジェクト キーです。例えば、Jira にリンクしようとしていて、プロジェクト キーが MYPROJ の場合、値は MYPROJ になります。
accountname はい リポジトリを所有しているチームまたは個人アカウント。
repo_slug はい リポジトリ ID。
object_id はい コンポーネントの識別子。

呼び出し元はリポジトリへの管理アクセス権限を持つユーザーとして認証する必要があります。 

{
    "handler": {
        "url": "http://yourjira.com/",
        "display_from": "JIRA (BB)",
        "name": "jira",
        "key": "BB",
        "display_to": "http://yourjira.com/"
    },
    "id": 87
}

Deletes the repository link identified by the object_id. The caller must authenticate as a user with administrative access to the repository. The caller can specify the following parameters:

パラメータ

必須かどうか

説明

accountname はい リポジトリを所有しているチームまたは個人アカウント。
repo_slug はい リポジトリ ID。
object_id はい コンポーネントの識別子。
DELETE https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/links/{object_id}

この呼び出しが成功した時に返される値は次のとおりです。

HTTP/1.1 204 NO CONTENT


最終更新日 2018 年 6 月 14 日

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

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