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/v7_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
Custom06	Custom value, its use is dependent on the specific data-sync plug-in
Custom07	Custom value, its use is dependent on the specific data-sync plug-in
Custom08	Custom value, its use is dependent on the specific data-sync plug-in
Custom09	Custom value, its use is dependent on the specific data-sync plug-in
Custom10	Custom value, its use is dependent on the specific data-sync plug-in
Custom11	Custom value, its use is dependent on the specific data-sync plug-in
Custom12	Custom value, its use is dependent on the specific data-sync plug-in
Custom13	Custom value, its use is dependent on the specific data-sync plug-in
Custom14	Custom value, its use is dependent on the specific data-sync plug-in
Custom15	Custom value, its use is dependent on the specific data-sync plug-in
Custom16	Custom value, its use is dependent on the specific data-sync plug-in
Custom17	Custom value, its use is dependent on the specific data-sync plug-in
Custom18	Custom value, its use is dependent on the specific data-sync plug-in
Custom19	Custom value, its use is dependent on the specific data-sync plug-in
Custom20	Custom value, its use is dependent on the specific data-sync plug-in
Custom21	Custom value, its use is dependent on the specific data-sync plug-in
Custom22	Custom value, its use is dependent on the specific data-sync plug-in
Custom23	Custom value, its use is dependent on the specific data-sync plug-in
Custom24	Custom value, its use is dependent on the specific data-sync plug-in
Custom25	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
IsActive	Is the data-sync system active

<RemoteDataSyncSystem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_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" />
  <Custom06 i:nil="true" />
  <Custom07 i:nil="true" />
  <Custom08 i:nil="true" />
  <Custom09 i:nil="true" />
  <Custom10 i:nil="true" />
  <Custom11 i:nil="true" />
  <Custom12 i:nil="true" />
  <Custom13 i:nil="true" />
  <Custom14 i:nil="true" />
  <Custom15 i:nil="true" />
  <Custom16 i:nil="true" />
  <Custom17 i:nil="true" />
  <Custom18 i:nil="true" />
  <Custom19 i:nil="true" />
  <Custom20 i:nil="true" />
  <Custom21 i:nil="true" />
  <Custom22 i:nil="true" />
  <Custom23 i:nil="true" />
  <Custom24 i:nil="true" />
  <Custom25 i:nil="true" />
  <DataSyncStatusId>0</DataSyncStatusId>
  <DataSyncStatusName i:nil="true" />
  <DataSyncSystemId>0</DataSyncSystemId>
  <Description i:nil="true" />
  <DisplayName i:nil="true" />
  <IsActive>false</IsActive>
  <LastSyncDate i:nil="true" />
  <Login i:nil="true" />
  <Name i:nil="true" />
  <Password i:nil="true" />
  <TimeOffsetHours>0</TimeOffsetHours>
</RemoteDataSyncSystem>

{"DataSyncSystemId":0,
"DataSyncStatusId":0,
"Name":null,
"DisplayName":null,
"Description":null,
"ConnectionString":null,
"Login":null,
"Password":null,
"TimeOffsetHours":0,
"LastSyncDate":null,
"Custom01":null,
"Custom02":null,
"Custom03":null,
"Custom04":null,
"Custom05":null,
"Custom06":null,
"Custom07":null,
"Custom08":null,
"Custom09":null,
"Custom10":null,
"Custom11":null,
"Custom12":null,
"Custom13":null,
"Custom14":null,
"Custom15":null,
"Custom16":null,
"Custom17":null,
"Custom18":null,
"Custom19":null,
"Custom20":null,
"Custom21":null,
"Custom22":null,
"Custom23":null,
"Custom24":null,
"Custom25":null,
"AutoMapUsers":false,
"DataSyncStatusName":null,
"IsActive":false}

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.

Nothing Returned

Nothing Returned