See all operations
PUT: data-syncs/{data_sync_system_id}
Description
Updates an existing data sync system entry
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):
https://api.inflectra.com/spira/services/v5_0/RestService.svc/data-syncs/{data_sync_system_id}
Request Parameters
|
Name
|
Description
|
|
data_sync_system_id
|
|
Request Body
|
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
|
|
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
|
<RemoteDataSyncSystem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<AutoMapUsers>false</AutoMapUsers>
<ConnectionString i:nil="true" />
<Custom01 i:nil="true" />
<Custom02 i:nil="true" />
<Custom03 i:nil="true" />
<Custom04 i:nil="true" />
<Custom05 i:nil="true" />
<DataSyncStatusId>0</DataSyncStatusId>
<DataSyncStatusName i:nil="true" />
<DataSyncSystemId>0</DataSyncSystemId>
<Description i:nil="true" />
<DisplayName i:nil="true" />
<LastSyncDate i:nil="true" />
<Login i:nil="true" />
<Name i:nil="true" />
<Password i:nil="true" />
<TimeOffsetHours>0</TimeOffsetHours>
</RemoteDataSyncSystem>
{"AutoMapUsers":false,
"ConnectionString":null,
"Custom01":null,
"Custom02":null,
"Custom03":null,
"Custom04":null,
"Custom05":null,
"DataSyncStatusId":0,
"DataSyncStatusName":null,
"DataSyncSystemId":0,
"Description":null,
"DisplayName":null,
"LastSyncDate":null,
"Login":null,
"Name":null,
"Password":null,
"TimeOffsetHours":0}
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.