Source Control Management Instance API

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.

Authentication - Use Basic Authentication for this API.

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)

Property Display NameProperty Key NameData TypeRequiredDescription
ClearCaseUCM URLFDCCUCM_URLStringYesURL of the ClearCase Server.
ClearCaseUCM UserFDCCUCM_USERStringYesClearCase User to connect with.
ClearCaseUCM PasswordFDCCUCM_PASSWORDStringYesClearCase Password for connecting user.

CVS (CVS)

Property Display NameProperty Key NameData TypeRequiredDescription
CVS URLFDCVS_URLStringYesURL to the CVS repository.
CVS UserFDCVS_PASSWORDStringYesCVS repository user.
CVS PasswordFDCVS_USERStringYesCVS repository password.

File System (FILE)

Property NameProperty Key NameData TypeRequiredDescription
File Repository RootFDFILE_REPO_ROOT_FOLDERStringYesLocation on the FlexDeploy server of the repository.

Git (GIT)

Property Display NameProperty Key NameData TypeRequiredDescription
Git URLFDGIT_URLStringYesURL to the Git repository.
Git UserFDGIT_USERStringYes/NoGit repository user.
Git PasswordFDGIT_PASSWORDStringYes/noGit repository password.
Git TimeoutFDGIT_TIMEOUTIntegerNoTimeout for Git command execution.

Perforce (PERF)

Property Display NameProperty Key NameData TypeRequiredDescription
Perforce HostFDPERF_HOSTStringYesHost of the Perforce repository.
Perforce PortFDPERF_PORTStringYesPort of the Perforce repository.
Perforce UserFDPERF_USERStringYesPerforce User to connect with.
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 TypeRequiredDescription
PVCS 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 TypeRequiredDescription
Subversion 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 TypeRequiredDescription
TFVC URLFDTFVC_URLStringYesURL to the TFVC repository.
TFVC UserFDTFVC_USERStringYesTFVC repository user.
TFVC PasswordFDTFVC_USERStringYesTFVC repository password.

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.

API URL

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

Request

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

AttributesTypeDescription
instanceIdLongThis 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<PropertyValue>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:

AttributesTypeDescription
propertyNameStringThis is the code of the property
propertyValueStringThis is the value of the property

Response Codes

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

Example

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

SCM Instance - 11101
{
   "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 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

SCM Instance GET 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
}

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.

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}

Examples:
To search by code only:

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

To search by name only:

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

To search by type and name:

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

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

NoQuery - String

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

Contains ignore case search

instanceCodeNoQuery - String

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

Equals ignore case search

scmTypeNoQuery - String

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

Equals ignore case search

Response

AttributesTypeDescription
instanceIdLongThis 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<PropertyValue>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:

AttributesTypeDescription
propertyNameStringThis is the code of the property
propertyValueStringThis is the value of the property

Response Codes

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

Example

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

SCM Instance - 11101
{
   "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 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

SCM Instance GET 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
}

POST

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

API URL

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

Parameters

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<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. 
instanceNameYesStringThis is the name that the SCM instance's name will be updated to.
scmTypeYesStringThis is the scm type of the SCM instance. 

Response Codes

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

Example

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

POST JSON
{
   "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
}

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

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
}

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.

API URL

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

Request

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<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. 
instanceNameYesStringThis is the name that the SCM instance's name will be updated to.
scmTypeYesStringThis is the SCM type of the SCM instance.

Response

AttributesTypeDescription
instanceIdLongThis 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<PropertyValue>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:

AttributesTypeDescription
propertyNameStringThis is the code of the property
propertyValueStringThis is the value of the property

Response Codes

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

Example

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

SCM Instance PUT JSON
{
   "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/v1/topology/integrations/scminstance/11101

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

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

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

SCM Instance PUT Return JSON
{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUT"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"
      }
   ],
   "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.

API URL

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

Request

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.
isActiveNoBooleanThis is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.
instanceCodeNoStringThis is the code that the SCM instance's code will be updated to.
propertiesNoList<PropertyValue>This is the list of Properties that will be updated in the SCM instance. Property values provided in input are updated, other values will be unchanged.
instanceNameNoStringThis is the name that the SCM instance's name will be updated to.
scmTypeYesStringThis is the SCM type of the SCM instance.

Response

AttributesTypeDescription
instanceIdLongThis 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<PropertyValue>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:

AttributesTypeDescription
propertyNameStringThis is the code of the property
propertyValueStringThis is the value of the property

Response Codes

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

Example

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

SCM Instance PATCH JSON
{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUT"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"
      }
   ],
   "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,

SCM Instance Patch Receive JSON
{
   "instanceName": null,
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch"
      },
   ],
   "scmType": "GIT",
   "description": null,
   "instanceCode": "CODE3",
   "isActive": true
}

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

SCM Instance PATCH Return JSON
{
   "instanceId": 11101,
   "instanceName": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"
      }
   ],
   "scmType": "GIT",
   "description": "descriptionPUT",
   "instanceCode": "CODE3",
   "isActive": true
}


The following macros are not currently supported in the footer:
  • style