Skip to content

TFS scmInstances

Request

Create a new instance of TFS SCM.
url* - URL in the below format:
<protocol>:<host>:<port>/<tfsroot>/<collection>/<project>
URL format for TFS 2016 and above:
<protocol>:<host>:<port>/<collection>/<project>
userName/password* - userName/password for authentication
changeSet - changeset you wish to sync.If Changeset is not provided, latest revision will be synced unless Label is specified.
label - Label you wish to sync. If Label is not provided, latest revision will be synced unless changeset is specified.

Security
bearerAuth
Query
projectIdinteger, (int64), >= 1required

ID of the project

Example:projectId=1
Bodyapplication/jsonrequired
urlstring, [ 0 .. 2400 ] charactersrequired

url

usernamestring, [ 0 .. 255 ] charactersrequired

userName

Example:"abc"
passwordstring, [ 0 .. 255 ] charactersrequired

password

Example:"abc"
changeSetstring, [ 0 .. 255 ] characters

changeSet

labelstring, [ 0 .. 255 ] characters

label

curl -i -X POST \
  'https://codeinsightapi.redocly.app/_mock/swagger/scmInstances/TFS?projectId=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "string",
    "username": "abc",
    "password": "abc",
    "changeSet": "string",
    "label": "string"
  }'

Responses

Created