SpiraPlan: REST Web Service (v7.0)

See all operations

GET: projects/{project_id}/source-code/providers

Description

Retrieves the currently active provider configuration for a particular product.

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

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
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