SCM

Contains APIs related to Scm

creates a Pull Request

SecurityApiKey
Request
Request Body schema:

Details to create a PR

sourceBranch
required
string

Source Branch for pull request

targetBranch
required
string

Target Branch for pull request

title
required
string

PR title

yamlGitConfigRef
string

Git Sync Config Id

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

useUserFromToken
boolean

Specifies which token to use. If True, the SCM token will be used, else the Git Connector token will be used

Responses
400

Bad Request

500

Internal Server Error

default

Successfully created a PR

post/ng/api/scm/createPR
Request samples
{
  • "sourceBranch": "string",
  • "targetBranch": "string",
  • "title": "string",
  • "yamlGitConfigRef": "string",
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "useUserFromToken": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets Git File Content

SecurityApiKey
Request
query Parameters
yamlGitConfigIdentifier
required
string

Git Sync Config Id.

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

filePath
required
string

File Path

branch
string

Name of the branch.

commitId
string

Commit Id

Responses
400

Bad Request

500

Internal Server Error

default

Git File Content including: object Id and content

get/ng/api/scm/fileContent
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Branches by given Git Sync Config Id

SecurityApiKey
Request
query Parameters
yamlGitConfigIdentifier
string

Git Sync Config Id.

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 50

Results per page

searchTerm
string
Default: ""

Search Term.

Responses
400

Bad Request

500

Internal Server Error

default

This contains a list of Branches specific to Git Sync Config Id

get/ng/api/scm/listBranchesByGitConfig
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Lists Branches of given Repo by referenced Connector Identifier

SecurityApiKey
Request
query Parameters
connectorIdentifierRef
string

Connector Identifier Reference

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

repoURL
string

URL of the repository.

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 50

Results per page

searchTerm
string
Default: ""

Search Term.

Responses
400

Bad Request

500

Internal Server Error

default

This contains a list of Branches specific to Referenced Connector Id

get/ng/api/scm/listRepoBranches
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}