• All Files

TFS REST API

The information on this page relates to the new upgraded interface of the IConduct platform. To view information about the Classic version of the user interface, follow this link.

 

Team Foundation Server  (TFS) is a Microsoft product that provides source code management, reporting, requirements management, project management, automated builds, lab management, testing and release management capabilities. It covers the entire application lifecycle, and enables DevOps capabilities. Representational State Transfer (REST) APIs are service endpoints that support sets of HTTP operations (methods), which provide create, retrieve, update, or delete access to the service's resources.

 

The TFS REST API connector by IConduct enables data import and export from/to the TFS system with support of all CRUD operations.

 

To configure the TFS REST API connector, follow the instructions below:

 

  1. In the Main Menu, select Connections and press Create connection.

Accessing connections

  1. On the Connector Selection Page select the TFS REST API item from the Source Controls section.

Connector Selection Page

  1. In the TFS REST work area, fill in the following fields and press Create.

Connection Details Area

Field Description

Connection*

The new connection name. Enter a connection alias here.

Is Active

Toggles connector’s activity at interface execution. Enable the checkbox to activate the connection for execution.

Cloud Agent*

The LAN you are working with. Select "IConduct" for cloud systems and your corporate agent for internal systems.

Implementation Type*

Defines the connection implementation type. Select from the drop-down list:

  • Default. IConduct scheduler works on the cloud agent set in the Cloud Agent field.
  • Java. IConduct scheduler works by sending requests to a Java agent.

Is Source

This connection entity is available as a data source for Import (writing to Schema). Enable the checkbox to ensure data import.

Is Target

This connection entity is available as a data target that receives data from schema to current data container. Enable the checkbox to ensure data export.

Timeout

The length of time (in milliseconds) the IConduct platform waits for a response from the connection provider before returning a timeout error. Set the time value to stop the system from connection attempts.

Query

The box is intended for entering a query. You can test the defined query by clicking Test Query once the connection is saved.

It’s recommended to test the query after the connection testing.

DateTime Format

Not used in this connector.

Server URL*

The service end-point where the request is sent. Specify the URL to your TFS system instance.

Example:

http://myserver:8080/tfs/DefaultCollection

http://mytenant.visualstudio.com/DefaultCollection

Authentication Type*

Authentication method to access the TFS system. Select from the drop-down list:

  • Active Directory: TFS authentication with your Microsoft Active Directory credentials.
  • Azure AD: TFS authentication with your Azure Active Directory credentials.
  • Basic: TFS authentication with your TFS credentials.
  • Personal Access Token: TFS authentication with your Personal Access Token. Type your Token in the Password field. The field Username is not applied.
  • Default: TFS authentication with your IConduct credentials.

Team Project*

The Team Project name in the TFS system.

Username/Password*

Credentials used to access the TFS system. The field entry depends on your Authentication Type selection.

Domain

Company’s domain name. Mandatory filed for the Active Directory authentication type.

*- mandatory fields

 

Once the connection is saved, you can test if it is successful. Press the Test Connection button. If the created connection works, you will receive a success message. 

Testing the Connection