AnchorTopTopSCM Instances can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow SCM Instances can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of SCM Instances.

...

Include Page

...

title	Base URL for SCM Instance REST API

...

http://host:port/flexdeploy/rest/topology/integrations/scminstance

toc

REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

Each function returns a JSON SCM instance object. The test SCM instance Object is an object that has these attributes,

AttributesTypeDescriptioninstanceIdLongThis is an id of the SCM Instance.instanceCodeStringThis is a code of the SCM instance.instanceNameStringThis is the unique name of the SCM instance.scmtypeStringThis is the SCM type of the SCM instance.isActiveBooleanThis is a Boolean that tracks whether or not the SCM instance is active.descriptionStringThis is the description of the SCM instance.propertiesList<PropertyValuePojo>This is a list of the Properties associated with the SCM instance.

Each JSON SCM instance object contains a list of property values. The property value object has these attributes:

AttributesTypeDescriptionpropertyNameStringThis is the name of the propertypropertyValueStringThis is the value of the property

Currently there are 8 different source control management types that are supported in Flex Deploy. The scmType value is shown after the name of each.

ClearCaseUCM (CCUCM

Currently there are 8 different source control management types that are supported in Flex Deploy. The scmType value is shown after the name of each.

CVS (CVS)

Property Display Name	Property Key Name	Data Type	Required	Description
CVS URL	`FDCVS_URL`	String	Yes	URL to the CVS repository.
CVS User	`FDCVS_PASSWORD`	String	Yes	CVS repository user.
CVS Password	`FDCVS_USER`	String	Yes	CVS repository password.

File System (FILE)

Property Name	Property Key Name	Data Type	Required	Description
File Repository Root	`FDFILE_REPO_ROOT_FOLDER`	String	Yes	Location on the FlexDeploy server of the repository.

Git (GIT)

Property Display Name	Property Key Name	Data Type	Required	Description
Git URL	FDGIT_URL	String	Yes	URL to the Git repository.
Git User	FDGIT_USER	String	Yes/No	Git repository user.
Git Password	FDGIT_PASSWORD	String	Yes/no	Git repository password.
Git Timeout	FDGIT_TIMEOUT	Integer	No	Timeout for Git command execution.

Perforce (PERF)

Property Display Name	Property Key Name	Data Type	Required	Description

ClearCaseUCM URL

Perforce Host

FDCCUCM

FDPERF_

URLClearCaseUCM UserFDCCUCM

HOST String Yes

URL of the ClearCase Server.

Host of the Perforce repository.
Perforce Port	`FDPERF_PORT`	String	Yes	Port of the Perforce repository.
Perforce User	`FDPERF_USER`	String	Yes

ClearCase

Perforce User to connect with.

ClearCaseUCM

Perforce User Password

FDCCUCM

FDPERF_PASSWORD String Yes

ClearCase Password for connecting user.

CVS (CVS

Perforce Password associated with Perforce User.
Perforce SSL Connection	`FDPERF_IS_SSL`	Boolean	Yes	Should ssl be used connecting to the server.

PVCS (PVCS)

Property Display Name	Property Key Name	Data Type	Required	Description

CVS URLFDCVS_URL

PVCS Project Database FDPVCS_PROJECT_DATABASE String Yes

URL to the CVS repository

Project Database Name.

CVS

PVCS User

FDCVS

FDPVCS_

PASSWORD

USER String Yes

CVS repository

PVCS user to access ProjectDatabases.

CVS

PVCS Password

FDCVS

FDPVCS_

USER

PASSWORD String Yes

CVS repository password.

File System (FILE)

Property NameProperty Key NameData TypeRequiredDescriptionFile Repository RootFDFILE_REPO_ROOT_FOLDERStringYesLocation on the FlexDeploy server of the repository.Git (GIT

PVCS password to access ProjectDatabases

Subversion (SVN)

Property Display Name	Property Key Name	Data Type	Required	Description

Git

Subversion URL

FDGIT

FDSVN_URL String Yes URL to the

Git

Subversion repository.

Git

Subversion User

FDGIT

FDSVN_USER String Yes

/No

Git

Subversion repository user.

Git

Subversion Password

FDGIT

FDSVN_PASSWORD String Yes

/no

Git

Subversion repository password.

Git TimeoutFDGIT_TIMEOUTIntegerNoTimeout for Git command execution.

Perforce (PERF

Subversion Authentication Methods FDSVN_AUTH_METHODS String No One or more subversion authentication methods. For example, Basic, Digest, Negotiate, NTLM.

TFVC (TFVC)

Property Display Name	Property Key Name	Data Type	Required	Description

Perforce Host

TFVC URL

FDPERF

FDTFVC_

HOST

URL String Yes

Host of

URL to the

Perforce

TFVC repository.

Perforce Port

TFVC User

FDPERF

FDTFVC_

PORT

USER String Yes

Port of the Perforce

TFVC repository user.

Perforce User

TFVC Password

FDPERF

FDTFVC_USER String Yes

Perforce User to connect with

TFVC repository password.

Perforce User PasswordFDPERF_PASSWORDStringYesPerforce Password associated with Perforce User.Perforce SSL ConnectionFDPERF_IS_SSLBooleanYesShould ssl be used connecting to the server.

PVCS (PVCS)

Property Display NameProperty Key NameData TypeRequiredDescriptionPVCS Project DatabaseFDPVCS_PROJECT_DATABASEStringYesProject Database Name.PVCS UserFDPVCS_USERStringYesPVCS user to access ProjectDatabases.PVCS PasswordFDPVCS_PASSWORDStringYesPVCS password to access ProjectDatabases

Subversion (SVN)

Property Display NameProperty Key NameData TypeRequiredDescriptionSubversion URLFDSVN_URLStringYesURL to the Subversion repository.Subversion UserFDSVN_USERStringYesSubversion repository user.Subversion PasswordFDSVN_PASSWORDStringYesSubversion repository password.Subversion Authentication MethodsFDSVN_AUTH_METHODSStringNoOne or more subversion authentication methods. For example, Basic, Digest, Negotiate, NTLM.

TFVC (TFVC)

Property Display NameProperty Key NameData TypeRequiredDescriptionTFVC URLFDTFVC_URLStringYesURL to the TFVC repository.TFVC UserFDTFVC_USERStringYesTFVC repository user.TFVC PasswordFDTFVC_USERStringYesTFVC repository password.

Back to Top

GET

There are two implementations of GET. One will find a SCM instance with the given Id and return the JSON representation of the SCM instance. The other will find a list of SCM instances matching the parameters supplied to it.

GET (Using Id)

This GET service will find a SCM instance with the given Id and return the JSON representation of the object.

Info

title	API URL

http://host:port/flexdeploy/rest/topology/integrations/scminstance/{Id}

Parameters

Parameter

Required

Type

Description

Id

YesURLThis is a URL parameter for the Id which is used to find and return a SCM instance with.

Response Codes

HTTP Code

Description

200SCM instance was found and returned400Bad request401Unauthorized500Unexpected internal server error

Example

If we had a SCM instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance - 11101

{ "instanceId": 11101, "instanceName": "ScmName1", "properties": [

GET

There are two implementations of GET. One will find a SCM instance with the given Id and return the JSON representation of the SCM instance. The other will find a list of SCM instances matching the parameters supplied to it.

GET (Using Id)

This GET service will find a SCM instance with the given Id and return the JSON representation of the object.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/{Id}

Request

Parameter	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return a SCM instance with.

Include Page

	REST V1 SCM Instance Response
	REST V1 SCM Instance Response

Response Codes

HTTP Code	Description
200	SCM instance was found and returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	SCM instance not found
500	Unexpected internal server error

Example

If we had a SCM instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance - 11101

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password",
		 "credentialId": 46259
      },
            {
         "propertyName": "FDGIT_URLTIMEOUT",
         "propertyValue": "url"
      }10000,
		 "credentialId": null
      }
  { ],
        "propertyNamescmType": "FDGIT_USERGIT",
     
   "propertyValuedescription": "user"
      },
     description",
      {
         "propertyName"instanceCode": "FDGIT_PASSWORDCODE1",
   "isActive": true
}

When we run a GET request at the following URL: http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/11101

The GET request would return the following JSON SCM instance object

Code Block

theme	Eclipse
title	SCM Instance GET Return JSON

{
   "propertyValue"instanceId": 11101,
   "instanceName": "passwordScmName1",
   "properties":   }, [
            {
         "propertyName": "FDGIT_TIMEOUTURL",
         "propertyValue": "10000url",
		 "credentialId": null
      },
            {
   ],      "scmTypepropertyName": "GITFDGIT_USER",
         "descriptionpropertyValue": "user",
		 "description",credentialId": null
      },
          "instanceCode  {
         "propertyName": "CODE1FDGIT_PASSWORD",
   "isActive":  true }

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/topology/integrations/scminstance/11101

The GET request would return the following JSON SCM instance object

Code Block

theme	Eclipse
title	SCM Instance GET Return JSON

{    "instanceIdpropertyValue": 11101"*****",
  		 "instanceNamecredentialId": "ScmName1",46259
   "properties":   },
[             {
         "propertyName": "FDGIT_URLTIMEOUT",
         "propertyValue": "url"
      }10000,
		 "credentialId": null
      }
  {  ],
       "propertyNamescmType": "FDGIT_USERGIT",
 
       "propertyValuedescription": "user"
      },
            {
    description",
    "propertyNameinstanceCode": "FDGIT_PASSWORDCODE1",
    
    "propertyValueisActive": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

Back to Top

GET (Using Query Parameters)

This GET service will find a SCM instance by querying based on a name, code, and/or type of the SCM and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of SCM instances.

...

true
}

GET (Using Query Parameters)

This GET service will find a SCM instance by querying based on a name, code, and/or type of the SCM and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of SCM instances.

Info

title	API URLs

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance?

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

instanceName={name}

instanceCode={code}

scmType={type}

isActive={boolean}

Examples:

To search by code only:

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance?instanceCode={code}

To search by

name

IsActive only:

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance?instanceNameisActive={nameboolean}

To search by

type and

name only:

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance?scmType={type}&instanceName={name}

Tip

To search by type and name:

http://host:port/flexdeploy/rest/v1/topology/scminstance?scmType={type}&instanceName={name}

Tip
The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name.

...

Request

Parameter	Required	Type	Description
instanceName	No

URL(query)

Query - String

This is a URL query parameter for the name which is used to query the SCM instances with.

Contains ignore case search

instanceCode

No

URL(query)

Query - String

This is a URL query parameter for the code which is used to query the SCM instances with.

Equals ignore case search

scmType

No

URL(query)

Query - String

This is a URL query parameter for the type which is used to query the SCM instances with.

Response Codes

HTTP Code

Description

200SCM Instances were found and

Equals ignore case search

isActive

No

Query - Boolean

Returns scm instances where isActive field matches parameter.

Include Page

	REST V1 SCM Instance Response
	REST V1 SCM Instance Response

Response Codes

HTTP Code	Description
200	Search successful and results returned
400	Bad request
401Unauthorized	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected internal server error

Example

If we had a SCM instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance - 11101

{
   "instanceId": 11101
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password",
		 "credentialId": 46259
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": 10000,
		 "10000credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance?code=code1&name=ScmName1

The GET request would return the following JSON SCM instance object

Code Block

theme	Eclipse
title	SCM Instance GET Return JSON

{
   "instanceId": 11101
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password",
		 "credentialId": 46259
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"10000,
		 "credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

Back to Top

POST

This POST service will create a new SCM instance with the same attributes as the given JSON object.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance

Code Block

theme	Eclipse
title	Sample POST JSON Request

{ "instanceId": 11101, "instanceName": "ScmName1", "properties": [ { "propertyName": "FDGIT_URL", "propertyValue": "url" },

Parameters

Parameters	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an SCM instance with.
description	No	String	This is the description that the SCM instance's description will be updated to.
isActive	Yes	Boolean	This is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.
instanceCode	Yes	String	This is the code that the SCM instance's code will be updated to.
properties	Yes/No	List<PropertyValue>	This is the list of Properties that will be updated in the SCM instance. The JSON object must have all of the properties of the SCM instance's type. More info on the PropertyValue object is included below.
instanceName	Yes	String	This is the name that the SCM instance's name will be updated to.
scmType	Yes	String	This is the scm type of the SCM instance.

PropertyValue

Attributes	Type	Description
propertyName	String	This is the code of the property
propertyValue	String	This is the value of the property
credentialId	Long	Id of the credential associated with this property. Applicable only for encrypted properties.

Response Codes

HTTP Code	Description
201	Instance was created successfully
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected internal server error

Example

If the POST request receives the following JSON test instance object,

Code Block

theme	Eclipse
title	POST JSON

{
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_

...

URL",
         "propertyValue": "

...

url",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_

...

USER",
         "propertyValue": "user",
		 "

...

credentialId": null
      },
            {
         "propertyName": "FDGIT_

...

PASSWORD",
         "propertyValue": "password",
		 "

...

credentialId": 46259
      },

...

propertyName": "FDGIT_TIMEOUT",
         "propertyValue": 10000,
		 "credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

...

Parameters

Required

Type

Description

IdYesURLThis is a URL parameter for the Id which is used to find and return an SCM instance with.descriptionNoStringThis is the description that the SCM instance's description will be updated to.isActiveYesBooleanThis is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.instanceCodeYesStringThis is the code that the SCM instance's code will be updated to.propertiesYes/NoList<PropertyValuePojo>This is the list of Properties that will be updated in the SCM instance. The JSON object must have all of the properties of the SCM instance's type. instanceNameYesStringThis is the name that the SCM instance's name will be updated to.instanceIdNoLongThis is the unique Id of the SCM instance. The SCM Instance will not be updated from this.scmtypeYesStringThis is the scm type of the SCM instance.

Response Codes

HTTP Code

Description

201Instance was created successfully400Bad request401Unauthorized404Instance not found500Unexpected internal server error

Example

If the POST request receives the following JSON test instance object,

Code Block

theme	Eclipse
title	POST JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [

The following SCM instance object will then be created as a new row in the database.

Code Block

theme	Eclipse
title	SCM Instance Post Return JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url",
		 "credentialId": null
      },

{
         "propertyName": "FDGIT_

URL

USER",
         "propertyValue":

"url"

"user",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_

USER

PASSWORD",
         "propertyValue": "password",
		 "

user

credentialId": 46259
      },
            {
         "propertyName": "FDGIT_

PASSWORD

TIMEOUT",
         "propertyValue":

"password" }

10000,
		 "credentialId": null
      }

{

 ],
   "scmType": "GIT",
   "

propertyName

description": "

FDGIT_TIMEOUT", "propertyValue": "10000" } ], "scmType": "GIT", "description": "

description",
   "instanceCode": "CODE1",
   "isActive": true
}

The following SCM instance object will then be created as a new row in the database.

Code Block

theme	Eclipse
title	SCM Instance Post Return JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

Back to Top

PUT

This PUT service will update all attributes of a SCM instance with the given Id based on the attributes of a JSON object paramaters.

Info

title	API URL

http://host:port/flexdeploy/rest/topology/integrations/scminstance/{Id}

Code Block

theme	Eclipse
title	Sample PUT JSON Request

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

Parameters

...

Parameters

...

Required

...

Type

...

Description

...

Response Codes

...

HTTP Code

...

Description

...

Example

If we had a SCM instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance PUT JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "scmType": "GIT",
   "description": "description",
   "instanceCode": "CODE1",
   "isActive": true
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/topology/integrations/scminstance/11101

...

PUT

This PUT service will update all attributes of a SCM instance with the given Id based on the attributes of a JSON object paramaters.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/{Id}

Request

Parameters	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an SCM instance with.
description	No	String	This is the description that the SCM instance's description will be updated to.
isActive	Yes	Boolean	This is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.
instanceCode	Yes	String	This is the code that the SCM instance's code will be updated to.
properties	Yes/No	List<PropertyValue>	This is the list of Properties that will be updated in the SCM instance. The JSON object must have all of the properties of the SCM instance's type. More info on the PropertyValue object is included below.
instanceName	Yes	String	This is the name that the SCM instance's name will be updated to.
scmType	Yes	String	This is the SCM type of the SCM instance.

PropertyValue

Attributes	Type	Description
propertyName	String	This is the code of the property
propertyValue	String	This is the value of the property
credentialId	Long	Id of the credential associated with this property. Applicable only for encrypted properties.

Include Page

	REST V1 SCM Instance Response
	REST V1 SCM Instance Response

Response Codes

HTTP Code	Description
200	SCM Instance was found and updated
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	SCM Instance not found
500	Unexpected internal server error

Example

If we had a SCM instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance PUT Receive JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName2ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url",
		 "urlPUTcredentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUTuser",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUTpassword",
		 "credentialId": 46259
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"10000,
		 "credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "descriptionPUTdescription",
   "instanceCode": "CODE2CODE1",
   "isActive": true
}

The PUT request would then update the SCM instance with Id 11101 and return the following JSON SCM instance objectWhen we run a PUT request at the following URL: http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/11101

And the PUT request recieves the following JSON SCM instace object,

Code Block

theme	Eclipse
title	SCM Instance PUT Return Receive JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": 10001,
		 "10001credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "descriptionPUT",
   "instanceCode": "CODE2",
   "isActive": true
}

Back to Top

PATCH

This PATCH service will update an existing SCM instance with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the SCM instance.

...

title	API URL

...

The PUT request would then update the SCM instance with Id 11101 and return the following JSON SCM instance object

Code Block

title
theme	Eclipse

...

SCM Instance PUT Return JSON

...

{
   "instanceId": 11101,
   "instanceName": "

...

ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT",
		 "

...

credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue":

...

"userPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "*****",
		 "

...

credentialId":

...

46259
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": 10001,
		 "

...

credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "

...

descriptionPUT",
   "instanceCode": "

...

CODE2",
   "

...

isActive": true
}

PATCH

This PATCH service will update an existing SCM instance with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the SCM instance.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/{Id}

Request

Parameters	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an SCM instance with.
description	No	String	This is the description that the SCM instance's description will be updated to.
isActive	No	Boolean	This is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.
instanceCode	No	String	This is the code that the SCM instance's code will be updated to.
properties	No

List<PropertyValuePojo>

List<PropertyValue>

This is the list of Properties that will be updated in the SCM instance.

The JSON object must have all of the properties of the SCM instance's type.

Property values provided in input are updated, other values will be unchanged. More info on the PropertyValue object is included below.
instanceName	No	String	This is the name that the SCM instance's name will be updated to.

instanceId

scmType

No

Yes

Long

String

This is the

unique Id

SCM type of the SCM instance.

The SCM Instance will not be updated from this.scmtypeYes

PropertyValue

Attributes	Type	Description
propertyName	String	This is the code of the property
propertyValue	String	This is

the SCM type of the SCM instance.

the value of the property
credentialId	Long	Id of the credential associated with this property. Applicable only for encrypted properties.

Include Page

	REST V1 SCM Instance Response
	REST V1 SCM Instance Response

Response Codes

HTTP Code	Description
200	SCM Instance was found and patched
400	Bad request
401Unauthorized	Authentication failure
403	Authorization failure (no access to resource)
404	SCM Instance not found
500	Unexpected internal server error

Example

If we had an test instance in our database with an Id of 11101 and had the following attributes

Code Block

theme	Eclipse
title	SCM Instance PATCH JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUT",
		 "credentialId": 46259
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": 10001,
		 "propertyValuecredentialId": "10001"null
      }
   ],
   "scmType": "GIT",
   "description": "descriptionPUT",
   "instanceCode": "CODE2",
   "isActive": true
}

When we run a PATCH request at the following URL: http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/11101

And the PATCH request receives the following JSON SCM instance object,

Code Block

theme	Eclipse
title	SCM Instance Patch Receive JSON

{
   "instanceId": 11101,
   "instanceName": null,
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch",
		 "credentialId": 15825
      },
   ],
   "scmType": "GIT",
   "description": null,
   "instanceCode": "CODE3",
   "isActive": true
}

The PATCH request would then update the SCM instance with Id 11101 and return the the following JSON SCM instance object

Code Block

theme	Eclipse
title	SCM Instance PATCH Return JSON

{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT",
		 "credentialId": null
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch""*****",
		 "credentialId": 15825
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001",
		 "credentialId": null
      }
   ],
   "scmType": "GIT",
   "description": "descriptionPUT",
   "instanceCode": "CODE3",
   "isActive": true
}

Back to Top

Page Comparison

Versions Compared

Old Version 20

New Version Current

Key

CVS (CVS)

File System (FILE)

Git (GIT)

Perforce (PERF)

PVCS (PVCS)

File System (FILE)

Subversion (SVN)

TFVC (TFVC)

PVCS (PVCS)

Subversion (SVN)

TFVC (TFVC)

GET

GET (Using Id)

Parameters

Response Codes

Example

GET

GET (Using Id)

Request

Response Codes

Example

GET (Using Query Parameters)

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To search by code only:

To search by

IsActive only:

To search by

name only:

To search by type and name:

Request

Response Codes

Response Codes

Example

POST

Parameters

Response Codes

Example

Parameters

Response Codes

Example

PUT

Parameters

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

PATCH

Request

Response Codes

Example