See all operations
POST: source-code/providers
Description
Creates a new system level source code provider configuration - needs to have at least Name, ConnectionInfo, Login, and Password populated
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/source-code/providers
Request Body
|
Property
|
Description
|
|
Name
|
This is the name of the source code provider integration which is being used such as GitProvider or SubversionProvider
|
|
Description
|
This is a description for any internal notes about what this source code provider does
|
|
VersionControlSystemId
|
Unique internal ID of this version control configuration
|
|
IsActive
|
Whether or not this configuration is active
|
|
ConnectionInfo
|
Connection info intended for this product
|
|
Login
|
Login credential for connecting to the relevant provider
|
|
Password
|
Update only password field for setting the password credential on a newly created provider or when updating a provider
|
|
Domain
|
Used by specific integrations for setting some domain information which is separate from the connection info
|
|
Custom01
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom02
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom03
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom04
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom05
|
Custom input field for behavior or information specific to a given source code provider
|
<RemoteSystemSourceCodeProvider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ConnectionInfo i:nil="true" />
<Custom01 i:nil="true" />
<Custom02 i:nil="true" />
<Custom03 i:nil="true" />
<Custom04 i:nil="true" />
<Custom05 i:nil="true" />
<Domain i:nil="true" />
<IsActive>false</IsActive>
<Login i:nil="true" />
<Password i:nil="true" />
<VersionControlSystemId>0</VersionControlSystemId>
<Description i:nil="true" />
<Name i:nil="true" />
</RemoteSystemSourceCodeProvider>
{"Name":null,
"Description":null,
"VersionControlSystemId":0,
"IsActive":false,
"ConnectionInfo":null,
"Login":null,
"Password":null,
"Domain":null,
"Custom01":null,
"Custom02":null,
"Custom03":null,
"Custom04":null,
"Custom05":null}
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
|
|
Name
|
This is the name of the source code provider integration which is being used such as GitProvider or SubversionProvider
|
|
Description
|
This is a description for any internal notes about what this source code provider does
|
|
VersionControlSystemId
|
Unique internal ID of this version control configuration
|
|
IsActive
|
Whether or not this configuration is active
|
|
ConnectionInfo
|
Connection info intended for this product
|
|
Login
|
Login credential for connecting to the relevant provider
|
|
Password
|
Update only password field for setting the password credential on a newly created provider or when updating a provider
|
|
Domain
|
Used by specific integrations for setting some domain information which is separate from the connection info
|
|
Custom01
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom02
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom03
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom04
|
Custom input field for behavior or information specific to a given source code provider
|
|
Custom05
|
Custom input field for behavior or information specific to a given source code provider
|
<RemoteSystemSourceCodeProvider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ConnectionInfo i:nil="true" />
<Custom01 i:nil="true" />
<Custom02 i:nil="true" />
<Custom03 i:nil="true" />
<Custom04 i:nil="true" />
<Custom05 i:nil="true" />
<Domain i:nil="true" />
<IsActive>false</IsActive>
<Login i:nil="true" />
<Password i:nil="true" />
<VersionControlSystemId>0</VersionControlSystemId>
<Description i:nil="true" />
<Name i:nil="true" />
</RemoteSystemSourceCodeProvider>
{"Name":null,
"Description":null,
"VersionControlSystemId":0,
"IsActive":false,
"ConnectionInfo":null,
"Login":null,
"Password":null,
"Domain":null,
"Custom01":null,
"Custom02":null,
"Custom03":null,
"Custom04":null,
"Custom05":null}