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 | ||||
|---|---|---|---|---|
|
...
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 Name | Property Key Name | Data Type | Required | Description |
|---|---|---|---|---|
| ClearCaseUCM URL | FDCCUCM_URL | String | Yes | URL of the ClearCase Server. |
| ClearCaseUCM User | FDCCUCM_USER | String | Yes | ClearCase User to connect with. |
| ClearCaseUCM Password | FDCCUCM_PASSWORD | String | Yes | ClearCase Password for connecting user. |
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 |
|---|---|---|---|---|
| Perforce Host | FDPERF_HOST | String | Yes | Host of the Perforce repository. |
| Perforce Port | FDPERF_PORT | String | Yes | Port of the Perforce repository. |
| Perforce User | FDPERF_USER | String | Yes | Perforce User to connect with. |
| Perforce User Password | FDPERF_PASSWORD | String | Yes | 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 |
|---|---|---|---|---|
| PVCS Project Database | FDPVCS_PROJECT_DATABASE | String | Yes | Project Database Name. |
| PVCS User | FDPVCS_USER | String | Yes | PVCS user to access ProjectDatabases. |
| PVCS Password | FDPVCS_PASSWORD | String | Yes | PVCS password to access ProjectDatabases |
Subversion (SVN)
| Property Display Name | Property Key Name | Data Type | Required | Description |
|---|---|---|---|---|
| Subversion URL | FDSVN_URL | String | Yes | URL to the Subversion repository. |
| Subversion User | FDSVN_USER | String | Yes | Subversion repository user. |
| Subversion Password | FDSVN_PASSWORD | String | Yes | Subversion repository password. |
| 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 |
|---|---|---|---|---|
| TFVC URL | FDTFVC_URL | String | Yes | URL to the TFVC repository. |
| TFVC User | FDTFVC_USER | String | Yes | TFVC repository user. |
| TFVC Password | FDTFVC_USER | String | Yes | TFVC 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.
...
| Info | ||
|---|---|---|
| ||
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} |
| 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) | This is a URL query parameter for the name which is used to query the SCM instances with. |
| instanceCode | No | URL(query) | This is a URL query parameter for the code which is used to query the SCM instances with. |
| scmType | No | URL(query) | This is a URL query parameter for the type which is used to query the SCM instances with. |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 200 | SCM Instances were found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Unexpected internal server error |
Example
...
| Info | ||||
|---|---|---|---|---|
| ||||
http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance | ||||
| Code Block | ||||
| ||||
| { "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 |
|---|---|---|---|
| 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. |
| instanceName | Yes | String | This is the name that the SCM instance's name will be updated to. |
| instanceId | No | Long | This is the unique Id of the SCM instance. The SCM Instance will not be updated from this. |
| scmType | Yes | String | This is the scm type of the SCM instance. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/integrations/scminstance/{Id} |
...