バージョン 1
Bitbucket Cloud v1 API は廃止予定です
Bitbucket Cloud REST API バージョン 1 は 2018 年 6 月 30 日に廃止予定となり、2019 年 4 月 29 日に REST API から完全に削除されました。廃止についての告知をご確認ください。または、バージョン 2.0 の REST API ドキュメントをご確認ください。
限られた 1.0 API リソースの一時的なサポートについて
The 2.0 REST API will rely on the Atlassian Cloud Admin API for user and group management, but those API endpoints are not yet available. Until the Atlassian platform services are fully available in Bitbucket we will continue to support these 1.0 REST endpoints:
1.0 のレスポンス形式
To use the Bitbucket Cloud Version 1 REST API, your application makes an HTTP request and parses the response. By default, the response format is JSON. If you wish, you can use the '?format=' query string parameter to override this behavior and receive XML or YAML instead. For example, use following query string to receive output in YAML:
?format=yamlまた、'?callback=' クエリ文字列パラメータと関数名を指定することで、レスポンスを JSONP 経由で受け取ることができます。例:
?callback=myJSfuncA Bitbucket Cloud response always includes a response header containing one of the following response codes:
| コード | 説明 |
|---|---|
| 200 OK | 成功時に返されます。GET メソッドの場合、レスポンスにはリクエストされたリソースに対応するエンティティが含まれます。POST メソッドの場合、作成されたエンティティが含まれます。 |
| 201 CREATED | 新しいリソース インスタンスが正常に作成された場合に返されます。 |
| 204 NO CONTENT | リソース インスタンスが正常に削除された場合に返されます。 |
| 400 BAD REQUEST | 不正な形式のリクエストが送信された場合に返されます。必須パラメータを設定し忘れた場合などにこの応答を受け取る可能性があります。 |
| 401 UNAUTHORIZED | 呼び出しで認証が必要で、提供された資格情報の認証に失敗した場合、または資格情報が提供されていない場合に返されます。 |
| 403 FORBIDDEN | 呼び出し元が、許可されていないリソースを呼び出しまたは変更しようとした場合に返されます。リクエストが有効で、呼び出し元の資格情報の認証に成功しても、呼び出し元にリソースへのアクセス権が付与されるわけではありません。 |
| 404 NOT FOUND | 指定したリソースが存在しない場合に返されます。 |
呼び出し内容よっては、レスポンスのボディが返されない場合があります。ボディが返される場合、JSON 形式の期待される構造については個々のドキュメントをご参照ください。
タイム ゾーン
返されるタイムスタンプのうち、キーに "utc" を含むすべてのものは、世界協定時刻で表されています。その他すべてのタイムスタンプはアムステルダムのローカル時刻で表されます。アムステルダム時間でのタイムスタンプは現在廃止予定です。自身のアプリケーション内で使用している場合、UTC に切り替えることをおすすめします。