Package com.xebialabs.xlrelease.api.v1
Interface RiskApi
- All Superinterfaces:
ApiService
@Path("/api/v1/risks")
@Produces("application/json")
@Consumes("application/json")
public interface RiskApi
extends ApiService
Operations on risk.
-
Field Summary
Fields inherited from interface com.xebialabs.xlrelease.api.ApiService
DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA
-
Method Summary
Modifier and TypeMethodDescriptioncopyRiskProfile
(RiskProfile riskProfile) Make copy of given risk profile.copyRiskProfile
(String riskProfileId) Make copy of risk profile with given id.createRiskProfile
(RiskProfile riskProfile) Create risk profile.void
deleteRiskProfile
(RiskProfile riskProfile) Delete risk profile.void
deleteRiskProfile
(String riskProfileId) Delete risk profile.Returns the list of all risk assessor.Returns the release risk score.Returns the release risk score.Returns the global risk thresholds configuration.getRiskProfile
(String riskProfileId) Returns the risk profile for the given identifier.getRiskProfileByTitle
(String title) Returns the risk profile with the given title.Returns list of all risk profile configurations.default String
updateRiskGlobalThresholds
(RiskGlobalThresholds thresholds) Update the global risk thresholds configuration.updateRiskProfile
(RiskProfile riskProfile) Update the risk profile.updateRiskProfile
(String riskProfileId, RiskProfile riskProfile) Update the risk profile.
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
getRisk
Returns the release risk score.- Parameters:
riskId
- the full identifier of release risk score.- Returns:
- risk.
-
getRisk
Returns the release risk score.- Parameters:
release
- the release from which you want risk score.- Returns:
- risk.
-
getRiskGlobalThresholds
Returns the global risk thresholds configuration.- Returns:
- global risk thresholds.
-
updateRiskGlobalThresholds
@PUT @Path("/config") RiskGlobalThresholds updateRiskGlobalThresholds(RiskGlobalThresholds thresholds) Update the global risk thresholds configuration.- Parameters:
thresholds
- the updated global risk thresholds.- Returns:
- global risk thresholds.
-
getRiskProfiles
Returns list of all risk profile configurations.- Returns:
- risk profiles list
-
getRiskProfile
@GET @Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*|new}") RiskProfile getRiskProfile(@PathParam("riskProfileId") String riskProfileId) Returns the risk profile for the given identifier.- Parameters:
riskProfileId
- the full identifier of risk profile.- Returns:
- risk profile.
-
getRiskProfileByTitle
Returns the risk profile with the given title.- Parameters:
title
- title of the risk profile.- Returns:
- risk profile.
-
updateRiskProfile
@PUT @Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}") RiskProfile updateRiskProfile(@PathParam("riskProfileId") String riskProfileId, RiskProfile riskProfile) Update the risk profile.- Parameters:
riskProfileId
- the full identifier of risk profile.riskProfile
- the updated risk profile.- Returns:
- the updated risk profile.
-
updateRiskProfile
Update the risk profile.- Parameters:
riskProfile
- the updated risk profile.- Returns:
- the updated risk profile.
-
createRiskProfile
Create risk profile.- Parameters:
riskProfile
- the new risk profile.- Returns:
- risk profile.
-
deleteRiskProfile
@DELETE @Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}") void deleteRiskProfile(@PathParam("riskProfileId") String riskProfileId) Delete risk profile.- Parameters:
riskProfileId
- the full identifier of risk profile.
-
deleteRiskProfile
Delete risk profile.- Parameters:
riskProfile
- the risk profile you would like to delete.
-
copyRiskProfile
@POST @Path("/profiles/{riskProfileId:.*/RiskProfile[^/]*}/copy") RiskProfile copyRiskProfile(@PathParam("riskProfileId") String riskProfileId) Make copy of risk profile with given id.- Parameters:
riskProfileId
- the full identifier of risk profile.- Returns:
- risk profile.
-
copyRiskProfile
Make copy of given risk profile.- Parameters:
riskProfile
- the risk profile from which a copy will be created.- Returns:
- risk profile.
-
getAllRiskAssessors
Returns the list of all risk assessor.- Returns:
- list of all risk assessor.
-