REST API Reference

Back Next

Getting commit history

Use the commitHistory resource to get commit history for source-controlled objects in your organization.

You can request commit history for all source-controlled objects, specific projects or folders, or specific assets. You can also use query parameters to request commit history for all objects on a particular Explore page or a specified number of pages.

GET request

You can request the commit history for all of your organization's projects and assets or request the history for a particular project or asset.

To get commit history, use the following URI:

/public/core/v3/commitHistory?<query parameters>

To get the commit history for all objects in the organization, omit the query parameters.

To get the commit history for a particular project or asset, you can include the following query parameters in the URI:

Parameter	Type	Description
q	String	Query filter string. Include an object ID, project or folder name, or asset type.
perPage	String	Number of entries to include per page. Maximum of entries is 100. Default is 100.
page	String	Show a specific page of results. Default is page 1.

You can use the following fields to define the query filter:

Field	Type	Operators	Description
id	String	==	ID of the project, folder, or asset.
path	String	==	Project or path where the assets are located.
type	String	==	Asset type. Required to receive commit history for an asset. Can be one of the following types: DTEMPLATE. Mapping. MTT. Mapping task. DSS. Synchronization task. DMASK. Masking task. DRS. Replication task. MAPPLET. BSERVICE. Business service definition. HSCHEMA. Hierarchical schema. PCS. PowerCenter task. FWCONFIG. Fixed width configuration. CUSTOMSOURCE. Saved query. MI_TASK. Mass ingestion task. WORKFLOW. Linear taskflow. VISIOTEMPLATE TASKFLOW PROCESS. Application Integration process. AI_CONNECTION. Application Integration app connection. AI_SERVICE_CONNECTOR. Application Integration service connector. GUIDE. Application Integration guide. PROCESS_OBJECT. Application Integration process object. HUMAN_TASK. Application Integration human task.

Query examples

The following examples show how you can use query parameters to get commit history for certain objects.

Commit history for a single asset or folder using IDs:

GET /public/core/v3/commitHistory?q=id=='23546'

Commit history for two projects using IDs:

GET /public/core/v3/commitHistory?q=id=='23423' and id=='5645esf'

Commit history for two projects using paths:

GET /public/core/v3/commitHistory?q=path=='project name 1' and path=='project name 2'

Commit history for an asset using the path:

GET /public/core/v3/commitHistory?q=path=='ProjectName/FolderName/AssetName1' and type=='DTEMPLATE'

GET response

Returns a list of commits with the latest commit listed first. Returns an error if errors occur.

If successful, returns the following information for each commit in the commits object:

Field	Type	Description
commits	List<Object>	List of all of the commits.
hash	String	Unique identifier for the commit.
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.
pagination	Object	Page information.
pageSize	Int	Number of elements on the page.
currentPage	Int	Current page number.
hasNext	Boolean	Whether there is another page after the current page.

Get response example

If successful, you might receive a response similar to the following example:

{
    "commits": [
        {
            "hash": "b0bdc63a7fb9047db6c3bc29ad67d5ecbf7d1d47",
            "summary": "Default Project v1",
            "description": "Default Project v1",
            "username": "testuser@gmail.com",
            "email": "testuser@gmail.com",
            "date": "2020-03-30T22:30:19.000Z",
            "committer": "testuserinfa"
        },
        {
            "hash": "fc6fcc318ad1b4aec17017d053bc2f0d1f605096",
            "summary": "Synchronization Task1 - Copy 1 v1",
            "description": "Synchronization Task1 - Copy 1 v1",
            "username": "testuser@gmail.com",
            "email": "testuser@gmail.com",
            "date": "2020-03-30T22:22:02.000Z",
            "committer": "testuserinfa"
        },
        {
            "hash": "74d776c574dad3bc5cf7a44b22195cf423560fe9",
            "summary": "Project2 Folder1 v1",
            "description": null,
            "username": "testuser@gmail.com",
            "email": "testuser@gmail.com",
            "date": "2020-03-30T22:17:48.000Z",
            "committer": "testuserinfa"
        },
        {
            "hash": "02c8b5950df4ef2110288ba7f77a220bc6f05b0a",
            "summary": "v1 of project2",
            "description": "v1 of project2",
            "username": "testuser@gmail.com",
            "email": "testuser@gmail.com",
            "date": "2020-03-24T23:41:52.000Z",
            "committer": "testuserinfa"
        },
    ],
    "pagination": null
}

Source control

Download Guide

Watch

Comments

Cloud Data Integration Homepage