See all operations
POST: projects/{project_id}/source-code/providers
Description
Adds a source code provider to a product with any desired product level configuration. Leave fields blank to use system configured defaults without exposing to product admins. System admins only.
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/projects/{project_id}/source-code/providers
Request Parameters
|
Name
|
Description
|
|
project_id
|
ID of the product to add this provider to
|
Request Body
|
Property
|
Description
|
|
ProjectId
|
ID of the product this source code provider configuration is for
|
|
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
|
<RemoteProductSourceCodeProvider 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>
<ProjectId>0</ProjectId>
</RemoteProductSourceCodeProvider>
{"ProjectId":0,
"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
|
|
ProjectId
|
ID of the product this source code provider configuration is for
|
|
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
|
<RemoteProductSourceCodeProvider 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>
<ProjectId>0</ProjectId>
</RemoteProductSourceCodeProvider>
{"ProjectId":0,
"VersionControlSystemId":0,
"IsActive":false,
"ConnectionInfo":null,
"Login":null,
"Password":null,
"Domain":null,
"Custom01":null,
"Custom02":null,
"Custom03":null,
"Custom04":null,
"Custom05":null}