Update an External SCM Repository Item

This page describes the process of updating external SCM repository items via Swagger.

Introduction

A new endpoint is available to update an existing, external SCM repository items via Swagger:

PUT/v3/trackers/projects/{projectId}/repository/{repositoryId}

Usage

To update and external SCM repository item,

1. Use the PUT/v3/trackers/projects/{projectId}/repository/{repositoryId} endpoint in Swagger.
2. Add the Codebeamer project ID to the projectId field.
3. Add the Codebeamer repository ID to the repositoryId field.
4. Provide the relevant details in the Request body.
   Example:
   

   {
     "accessTokenId": 6326,
     "accessTokenName": "token_Test1",
     "accessTokenValue": "8C-2W-5Z-1P-7F",
     "enablePatchSynchronization": true,
     "name": "TestRepository",
     "ownerName": "CBTest",
     "projectName": "CB-Test-Project",
     "remoteApiUrl": "https://dev.azure.com",
     "repositoryName": "TestAzure",
     "scmType": "azurerepo",
     "secretId": 1
   }
   

5. Click Execute.

By clicking Execute, the existing external SCM repository for which the details are provided in the Request body is updated if all the details are provided correctly.

If the Request body contains any incorrect values, the API request fails.

Parameters of the Request Body

The following details need to be provided in the Request body. The same parameters must be provided in the Request body as if an existing external SCM repository was updated on the user interface.