Anchor

	Top
	Top

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

title	Base URL for Test Instance REST APIService

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

...

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

Attributes	Type	Description

Code


id	Long	This is an id of the SCM Instance.
code	String	This is a code of the SCM instance.

Type

name	String	This is the unique name of the SCM instance.
type	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

description

String

This is the description of the SCM instance.

NameStringThis is the unique name of the SCM instance.PropertiesList<Property>

properties

List<PropertyValuePojo>

This is a list of the Properties associated with the SCM instance.

Currently there are 8 different source control management types that are supported in Flex Deploy.

ClearCaseUCM

Property Name	Type	Required	Description
ClearCaseUCM URL	String	Yes	URL of the ClearCase Server.
ClearCaseUCM User	String	Yes	ClearCase User to connect with.
ClearCaseUCM Password	String	Yes	ClearCase Password for connecting user.

CVS

Property Name	Type	Required	Description
CVS URL	String	Yes	URL to the CVS repository.
CVS User	String	Yes	CVS repository user.
CVS Password	String	Yes	CVS repository password.

File System

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

Git

Property Name	Type	Required	Description
Git URL	String	Yes	URL to the Git repository.
Git User	String	Yes/No	Git repository user.
Git Password	String	Yes/no	Git repository password.
Git Timeout	Integer	No	Timeout for Git command execution.

Perforce

Property Name	Type	Required	Description
Perforce Host	String	Yes	Host of the Perforce repository.
Perforce Port	String	Yes	Port of the Perforce repository.
Perforce User	String	Yes	Perforce User to connect with.
Perforce User Password	String	Yes	Perforce Password associated with Perforce User.
Perforce SSL Connection	Boolean	Yes	Should ssl be used connecting to the server.

PVCS

Property Name	Type	Required	Description
PVCS Project Database	String	Yes	Project Database Name.
PVCS User	String	Yes	PVCS user to access ProjectDatabases.
PVCS Password	String	Yes	PVCS password to access ProjectDatabases

Subversion

Property Name	Type	Required	Description
Subversion URL	String	Yes	URL to the Subversion repository.
Subversion User	String	Yes	Subversion repository user.
Subversion Password	String	Yes	Subversion repository password.
Subversion Authentication Methods	String	No	One or more subversion authentication methods. For example, Basic, Digest, Negotiate, NTLM.

TFVC

Property Name	Type	Required	Description
TFVC URL	String	Yes	URL to the TFVC repository.
TFVC User	String	Yes	TFVC repository user.
TFVC Password	String	Yes	TFVC 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 URLs

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:

name={name}

code={code}

Examples:

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

Parameters

Parameter	Required	Type	Description
name	No	URL(query)	This is a URL query parameter for the name which is used to query the SCM instances with.
code	No	URL(query)	This is a URL query parameter for the code which is used to query the SCM instances with.
type	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

...

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.
Codecode	Yes	String	This is the code that the SCM instance's code will be updated to.
properties	Yes/No	List<PropertyPojo>List<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.
Namename	Yes	String	This is the name that the SCM instance's name will be updated to.

...

Info

title	API URL

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

Code Block

theme	Eclipse
title	Sample PUT JSON Request

{
   "name": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "type": "GIT",
   "description": "description",
   "code": "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.
Codecode	Yes	String	This is the code that the SCM instance's code will be updated to.
properties	Yes/No	List<PropertyPojo>List<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.
Namename	Yes	String	This is the name that the SCM instance's name will be updated to.

...

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.

Info

title	API URL

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

...

Code Block

theme	Eclipse
title	Sample JSON Request

{
   "name": "ScmName1",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "url"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "user"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "password"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10000"
      }
   ],
   "type": "GIT",
   "description": "description",
   "code": "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	No	Boolean	This is the isActive Boolean that the SCM instance's isActive Boolean will be updated to.

Code

code	No	String	This is the code that the SCM instance's code will be updated to.
properties	No

List<PropertyPojo>

List<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.

Name

name

No

String

This is the name that the SCM instance's name will be updated to.

Response Codes

HTTP Code	Description
200	SCM Instance was found and patched
400	Bad request
401	Unauthorized
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

{
   "name": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPUT"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPUT"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"
      }
   ],
   "type": "GIT",
   "description": "descriptionPUT",
   "code": "CODE2",
   "isActive": true
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/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

{
   "name": null,
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch"
      },
   ],
   "type": "GIT",
   "description": null,
   "code": "CODE3",
   "isActive": true
}

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

Code Block

theme	Eclipse
title	SCM Instance PATCH Return JSON

{
   "name": "ScmName2",
   "properties":    [
            {
         "propertyName": "FDGIT_URL",
         "propertyValue": "urlPatch"
      },
            {
         "propertyName": "FDGIT_USER",
         "propertyValue": "userPUT"
      },
            {
         "propertyName": "FDGIT_PASSWORD",
         "propertyValue": "passwordPatch"
      },
            {
         "propertyName": "FDGIT_TIMEOUT",
         "propertyValue": "10001"
      }
   ],
   "type": "GIT",
   "description": "descriptionPUT",
   "code": "CODE3",
   "isActive": true
}

Back to Top

...

Version	Old Version 2	New Version 3
Changes made by	Keith Ecker (Unlicensed)	Chandresh Patel
Saved on	Jun 27, 2018	Jul 03, 2018

Versions Compared

Key

ClearCaseUCM

CVS

File System

Git

Perforce

PVCS

Subversion

TFVC

GET

GET (Using Id)

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 name only:

To search by type and name:

Parameters

Response Codes

Example

Parameters

PATCH

Parameters

Response Codes

Example

Page Comparison

Versions Compared

Key

ClearCaseUCM

CVS

File System

Git

Perforce

PVCS

Subversion

TFVC

GET

GET (Using Id)

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 name only:

To search by type and name:

Parameters

Response Codes

Example

Parameters

PATCH

Parameters

Response Codes

Example