REST API Reference

Back Next

Getting repository connection details

Use the repositoryConnection resource to get repository details such as the repository connection ID for a given project ID or project name. You can get the repository details for one or more projects in one request.

Use the repository connection ID that's included in the response to send a pullByCommitHash request for objects in project-level repositories.

GET request

To get details about the repository connection for a given project, use the following URL:

/public/core/v3/repositoryConnection

You can include the following fields in the request:

Field	Type	Required	Description
projectIds	List of String	-	Project ID that you want to find the repository connection details for.
projectName	List of String	-	Project name that you want to find the repository connection details for.

GET response

If successful, a GET request returns the following information:

Field	Type	Description
pullActionId	String	ID for the pull operation.
projectRepoConnections	List <Object>	Object that contains repository details for each project ID or project name included in the request.
projectId	String	Returned in the projectRepoConnections object. ID of the project. Included when the project ID was included in the request.
projectName	String	Returned in the projectRepoConnections object. Name of the project. Included when the project name was included in the request.
gitRepositoryURL	String	Git repository URL.
gitRepositoryBranch	String	Git repository branch.
globalRepository	Boolean	Whether project is configured with a global Git repository. If true, repoConnectionId is null.
repoConnectionId	String	Repository connection ID for the project. Null if the project isn't configured with a project-level Git repository.

GET request example

To request repository connection details for two project using project ID, the request might look like the following example:

https://{{pod_link}}/saas/public/core/v3/repositoryConnection?projectIds=6ub6oUKHJ8Dkr3QXbGG9Sm,5FmdSKPASroei2vyeXwFeT

GET response example

For a successful GET request, the response might look like the following example:

{
    "projectRepoConnections": [
        {
            "projectId": "6ub6oUKHJ8Dkr3QXbGG9Sm",
            "projectName": "customProject2",
            "globalRepository": false,
            "gitRepositoryURL": "https://priraj@dev.azure.com/priraj/infa-cloud-vcs-azure/_git/infa-cloud-vcs-azure",
            "gitRepositoryBranch": "main",
            "repoConnectionId": "1rMeeN2te0TetGYVtRS3GS"
        },
        {
            "projectId": "5FmdSKPASroei2vyeXwFeT",
            "projectName": "TestProject",
            "globalRepository": true,
            "gitRepositoryURL": "https://priraj@dev.azure.com/priraj/infa-cloud-vcs/_git/infa-cloud-vcs",
            "gitRepositoryBranch": "main",
            "repoConnectionId": null
        }
    ]
}

Source control

Download Guide

Watch

Comments

Cloud Data Integration Homepage