Package com.xebialabs.xlrelease.api.v1
Interface ConfigurationApi
- All Superinterfaces:
ApiService
@Path("/api/v1/config")
@Consumes("application/json")
@Produces("application/json")
public interface ConfigurationApi
extends ApiService
Operations on global variables and other configuration.
-
Field Summary
FieldsFields 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 TypeMethodDescriptionaddConfiguration
(Configuration configuration) Creates a new configuration.addGlobalVariable
(Variable variable) Adds a global variable.checkStatus
(ConfigurationView configurationView) checkStatus
(String configurationId) void
deleteConfiguration
(String configurationId) Deletes the configuration.void
deleteGlobalVariable
(String variableId) Deletes a global variable.getConfiguration
(String configurationId) Returns the configuration with the given ID.getConfigurations
(List<String> configurationIds) Returns the list of configurations for the given list of IDs.getGlobalVariable
(String variableId) Returns the global variable for the given identifier.Returns global variables list.Returns global variables list with replaced variable values.List<? extends ConfigurationItem>
searchByTypeAndTitle
(String configurationType, String title) Searches configuration objects by type and title.List<? extends ConfigurationItem>
searchByTypeAndTitle
(String configurationType, String title, String folderId) Searches configuration objects by type and title.searchByTypeAndTitle
(String configurationType, String title, String folderId, boolean folderOnly) Searches configuration objects by type and title.default String
updateConfiguration
(Configuration configuration) Updates the configuration.updateConfiguration
(String configurationId, Configuration configuration) Updates the configuration.updateGlobalVariable
(Variable variable) Updates properties of a global variable by its ID.updateGlobalVariable
(String variableId, Variable variable) updateSystemMessage
(SystemMessageSettings systemMessageSettings)
-
Field Details
-
SERVICE_NAME
- See Also:
-
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
getGlobalVariables
Returns global variables list.- Returns:
- variables list.
-
getGlobalVariableValues
Returns global variables list with replaced variable values.- Returns:
- variables list.
-
getGlobalVariable
@GET @Path("/{variableId:.*/Variable[^/]*}") Variable getGlobalVariable(@PathParam("variableId") String variableId) Returns the global variable for the given identifier.- Parameters:
variableId
- the variable identifier.- Returns:
- the variable.
-
addGlobalVariable
Adds a global variable.- Parameters:
variable
- the global variable to add.- Returns:
- the added global variable.
-
updateGlobalVariable
-
updateGlobalVariable
Updates properties of a global variable by its ID.- Parameters:
variable
- the variable to update.- Returns:
- the updated variable.
-
deleteGlobalVariable
@DELETE @Path("/{variableId:.*/Variable[^/]*}") void deleteGlobalVariable(@PathParam("variableId") String variableId) Deletes a global variable.- Parameters:
variableId
- the variable identifier.
-
searchByTypeAndTitle
Searches configuration objects by type and title.- Parameters:
configurationType
- the type of the Configuration object.title
- the title of the Configuration object.(optional)- Returns:
- returns the first 100 results loaded with depth 1. Password properties are not returned.
-
searchByTypeAndTitle
List<? extends ConfigurationItem> searchByTypeAndTitle(String configurationType, String title, String folderId) Searches configuration objects by type and title.- Parameters:
configurationType
- the type of the Configuration object.title
- the title of the Configuration object.(optional)folderId
- the path of a parent.(optional)- Returns:
- returns the first 100 results loaded with depth 1. Password properties are not returned.
-
searchByTypeAndTitle
@GET @Path("byTypeAndTitle") List<Configuration> searchByTypeAndTitle(@QueryParam("configurationType") String configurationType, @QueryParam("title") String title, @QueryParam("folderId") String folderId, @QueryParam("folderOnly") boolean folderOnly) Searches configuration objects by type and title.- Parameters:
configurationType
- the type of the Configuration object.title
- the title of the Configuration object.(optional)folderId
- the path of a parent.(optional)folderOnly
- filter if you only want to get information from your parentId. (optional)- Returns:
- returns the first 100 results loaded with depth 1. Password properties are not returned.
-
getConfigurations
Returns the list of configurations for the given list of IDs.- Parameters:
configurationIds
- the list of IDs for configuration items to fetch- Returns:
- the list of configuration instances
-
getConfiguration
@GET @Path("/{configurationId:.*/Configuration[^/]*}") Configuration getConfiguration(@PathParam("configurationId") String configurationId) Returns the configuration with the given ID.- Parameters:
configurationId
- the identifier of the configuration- Returns:
- the configuration instance
-
addConfiguration
Creates a new configuration.- Parameters:
configuration
- the configuration to add.- Returns:
- the created configuration.
-
updateConfiguration
@PUT @Path("{configurationId:.*/Configuration[^/]*}") Configuration updateConfiguration(@PathParam("configurationId") String configurationId, Configuration configuration) Updates the configuration.- Parameters:
configurationId
- the identifier of the configuration.configuration
- new contents of the configuration.- Returns:
- the updated configuration.
-
updateConfiguration
Updates the configuration.- Parameters:
configuration
- new contents of the configuration.- Returns:
- the updated configuration.
-
deleteConfiguration
@DELETE @Path("{configurationId:.*/Configuration[^/]*}") void deleteConfiguration(@PathParam("configurationId") String configurationId) Deletes the configuration.- Parameters:
configurationId
- the identifier of the configuration.
-
getSystemMessage
-
updateSystemMessage
@PUT @Path("system-message") SystemMessageSettings updateSystemMessage(SystemMessageSettings systemMessageSettings) -
checkStatus
@POST @Path("status") SharedConfigurationStatusResponse checkStatus(ConfigurationView configurationView) -
checkStatus
@POST @Path("{configurationId:.*/Configuration[^/]*}/status") SharedConfigurationStatusResponse checkStatus(@PathParam("configurationId") String configurationId)
-