REST APIリファレンス

前へ次へ

コミットの詳細の取得

commitリソースを使用して、コミットに関する詳細をリポジトリから取得します。

GET要求

コミットの詳細を取得するには、次のURIを使用します:

/public/core/v3/commit/<commitHash>

プロジェクトレベルのリポジトリを使用する場合は、次のパラメータの1つまたは両方をURIに含めます。

フィールド	タイプ	必須	説明
searchCustomRepositories	Boolean	-	グローバルリポジトリのコミットハッシュが見つからなかった場合にプロジェクトレベルのリポジトリを検索するかどうかを示します。
repoConnectionId	String	-	検索するプロジェクトレベルのリポジトリの接続ID。リポジトリ接続IDを見つけるには、repositoryConnection要求を送信します。詳細については、Getting repository connection detailsを参照してください。

GET応答

成功した場合、GET要求は次の情報を返します。

フィールド	タイプ	説明
hash	String	コミットの一意のID。この値は、pullByCommitHash要求で使用できます。
サマリ	String	コミットハッシュに関連付けられたサマリ。
description	String	コミットハッシュに関連付けられた詳細な説明。
username	String	コミットを実行したユーザーの名前。
email	String	コミットを実行したユーザーの電子メールアドレス。
date	Date	コミットが yyyy-MM-dd'T'HH:mm:ss.SSSZ 形式で送信されたときのタイムスタンプ
committer	String	コミットをファイル作成したGitユーザー。
changes	List <Object>	コミットに含まれる各オブジェクトの変更の詳細を含みます。
id	String	changesオブジェクトに含まれます。オブジェクトのグローバル一意識別子。オブジェクトが現在組織に存在する場合に含まれます。
appContextId	String	changesオブジェクトに含まれます。 REST APIバージョン2の呼び出しで使用されるコンテキスト内のオブジェクトのID。オブジェクトが現在組織に存在する場合に含まれます。
name	String	changesオブジェクトに含まれます。アセット、プロジェクト、またはフォルダの名前。
type	String	changesオブジェクトに含まれます。オブジェクトのタイプ。
path	List <String>	changesオブジェクトに含まれます。オブジェクトのフルパス。
oldPath	List <String>	changesオブジェクトに含まれます。コミット前のオブジェクトのリモートリポジトリパス。オブジェクトが移動されたかその名前が変更された場合に含まれます。
action	String	changesオブジェクトに含まれます。コミット中にオブジェクトに加えられた変更のタイプを示します。次のいずれかの値を含みます。 ADDED DELETED MODIFIED MOVED

GET要求の例

グローバルリポジトリを使用する場合、GET要求は次の例のようになります。

GET <baseApiUrl>/public/core/v3/commit/aca30f6c44de9bef23db59ed16967653481c5e23
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

プロジェクトレベルのリポジトリを使用する場合、GET要求は次の例のようになります。

GET <baseApiUrl>/public/core/v3/commit/aca30f6c44de9bef23db59ed16967653481c5e23
?searchCustomRepositories=true
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

プロジェクトレベルのリポジトリを使用していて、リポジトリ接続IDを含める場合、GET要求は次の例のようになります。

GET <baseApiUrl>/public/core/v3/commit/aca30f6c44de9bef23db59ed16967653481c5e23?repoConnectionId=6ub6oUKHJ8Dkr3QXbGG9Sm
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

GET応答の例

GET応答は次の例のようになります。

{
    "hash": "aca30f6c44de9bef23db59ed16967653481c5e23",
    "summary": "Update. ",
    "description": "Restructured and updated.",
    "username": "testuser",
    "email": "user@gmail.com",
    "date": "2019-05-13T17:50:46.000Z"
    "committer": "Alexander Freeman",
    "changes": [
        {
            "id": "5G15DJ19Fw3j20XGL6oooL",
            "appContextId": "N0A1700000000001J",
            "name": "Mapping1",
            "type": "DTEMPLATE",
            "path": ["Versioned_Project2","Mapping1"],
            "action": "MODIFIED"
        },
        {
            "id": "2jFxl7stzKgi3lKAtVpWi3",
            "appContextId": "N0A17000000003A02",
            "name": "Versioned_Project",
            "type": "Project",
            "path": ["Versioned_Project"],
            "action": "ADDED"
        },
        {
            "id": "k3SYVglqhAafSWHuQuZdm1",
            "appContextId": "N0F17000000000291",
            "name": "Versioned_Folder",
            "type": "Folder",
            "path": ["Versioned_Project", "Versioned_Folder"],
            "oldPath": ["Versioned_Project", "Test_Folder"],
            "action": "MOVED"
        },
        {
            "id": null,
            "appContextId": null,
            "name": "Mapping2",
            "type": "DTEMPLATE",
            "path": ["Versioned_Project2","Mapping2"],
            "action": "DELETED"
        }
    ]
}

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal