| Anchor | ||||
|---|---|---|---|---|
|
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.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/integrations/scminstance |
...
Each function returns a JSON SCM instance object. The test SCM instance Object is an object that has these attributes,
| Attributes | Type | Description |
|---|---|---|
| instanceId | Long | This is an id of the SCM Instance. |
| instanceCode | String | This is a code of the SCM instance. |
| instanceName | String | This is the unique name of the SCM instance. |
| scmtype | String | This is the SCM type of the SCM instance. |
| isActive | Boolean | This is a Boolean that tracks whether or not the SCM instance is active. |
| description | String | This is the description of the SCM instance. |
| properties | List<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:
| Attributes | Type | Description |
|---|---|---|
| propertyName | String | This is the name of the property |
| propertyValue | String | This 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)
| 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/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/topology/integrations/scminstance?instanceCode={code} To search by name only:http://host:port/flexdeploy/rest/topology/integrations/scminstance?instanceName={name} To search by type and name:http://host:port/flexdeploy/rest/topology/scminstance?scmType={type}&instanceName={name} |
| Tip |
|---|
The query parameters are not case sensitive. Searching by nameinstanceName=NAME is the same as searching by nameinstanceName=name. |
Parameters
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. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | SCM Instances were found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 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
...
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/topology/integrations/scminstance/{Id} |
...