REST API Reference

Back Next

Getting commit details

Use the commit resource to retrieve details about a commit from your repository.

GET request

To get the details for a commit, use the following URI:

/public/core/v3/commit

You can include the following fields in the request:

Field	Type	Required	Description
commitHash	String	Yes	The commit hash that you're requesting details for.
searchCustomRepositories	Boolean	-	Whether to search project-level repositories if the commit hash wasn't found for the global repository.
repoConnectionId	String	-	Connection ID of the project-level repository to search. To find the repository connection ID, you can send a repositoryConnection request. For more information, see <link to the new Getting repository connection details topic>

GET response

If successful, a GET request returns the following information:

Field	Type	Description
hash	String	Unique identifier for the commit. You can use this value in a pullByCommitHash request.
summary	String	Summary associated with the commit hash.
description	String	Detailed description associated with the commit hash.
username	String	Name of the user who performed the commit.
email	String	Email address of the user who performed the commit.
date	Date	The timestamp when the commit was submitted in the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
committer	String	The Git user who filed the commit.
changes	List <Object>	Contains change details for each object included in the commit.
id	String	Included in the changes object. Global unique identifier for the object. Included if the object currently exists in your organization.
appContextId	String	Included in the changes object. ID of the object in context, used in REST API version 2 calls. Included if the object currently exists in your organization.
name	String	Included in the changes object. Name of the asset, project, or folder.
type	String	Included in the changes object. Type of object.
path	List <String>	Included in the changes object. Full path of the object.
oldPath	List <String>	Included in the changes object. Remote repository path for the object before the commit. Included when the object was moved or renamed.
action	String	Included in the changes object. Indicates the type of changes made to the object during the commit. Includes one of the following values: ADDED DELETED MODIFIED MOVED

GET response example

A GET response might look like the following example:

{
    "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"
        }
    ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting commit details

Getting commit details

GET request

GET response

GET response example