SpiraTeam: REST Web Service (v5.0)

See all operations

GET: data-syncs/{data_sync_system_id}

Description

Retrieves a single data sync system by its ID

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

http://api.inflectra.com/Spira/Services/v5_0/RestService.svc/data-syncs/{data_sync_system_id}

Request Parameters

Name Description
data_sync_system_id The id of the system

Request Body

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
DataSyncSystemId The id the data-sync plug-in
DataSyncStatusId The id of the synchronization status (for the last time it ran)
Name The name of the data-sync plug-in
DisplayName The display name of the data-sync plug-in
Description The description of the data-sync plug-in
ConnectionString The connection string (often a URL) for accessing the external system
Login The username / login for accessing the external system
Password The password for accessing the external system
TimeOffsetHours The number of hours to add to the last-updated date/times when making comparisons
LastSyncDate The date/time that the data-sync last ran
Custom01 Custom value, its use is dependent on the specific data-sync plug-in
Custom02 Custom value, its use is dependent on the specific data-sync plug-in
Custom03 Custom value, its use is dependent on the specific data-sync plug-in
Custom04 Custom value, its use is dependent on the specific data-sync plug-in
Custom05 Custom value, its use is dependent on the specific data-sync plug-in
AutoMapUsers Should we attempt to auto-map user in the two systems
DataSyncStatusName The display name of the synchronization status