Package com.xebialabs.deployit.core.api

Interface ApplicationStatusService

@Path("/application-status") @Produces("application/json") public interface ApplicationStatusService
Retrieves information about DeployedApplications A User must have READ permission on the environment and application to obtain the requested info.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.xebialabs.deployit.engine.api.dto.ApplicationDeploymentPackageState>
    getDeployedApplications(String deployedAppName, String path, boolean exactPath, com.xebialabs.deployit.engine.api.dto.Ordering order, List<String> folders)
    Finds all DeployedApplications and DeploymentTasks whilst reducing them to show current status of any deployed or deploying application.
    List<String>
    getFilterableFolders()
    Finds all available Application folders path list

  • Method Details

    • getDeployedApplications

      @GET @Path("deployed-applications") List<com.xebialabs.deployit.engine.api.dto.ApplicationDeploymentPackageState> getDeployedApplications(@QueryParam("deployedAppName") String deployedAppName, @QueryParam("path") String path, @QueryParam("exactPath") boolean exactPath, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order, @QueryParam("folders") List<String> folders)
      Finds all DeployedApplications and DeploymentTasks whilst reducing them to show current status of any deployed or deploying application. Optionally, part of the application name or start of application path/id (full path/id if exactPath flag is enabled) can be specified to narrow the search result. A list of ApplicationDeploymentPackageState objects will be returned containing information about current state of any deployed or deploying application package.
      Parameters:
      deployedAppName - (Optional) (part of the) deployed application name to query
      path - (Optional) (start of) the application path or id to query
      exactPath - (Optional) use full application path in queries (defaults to false)
      order - (Optional) which ordering to use when listing results. Ordering params supported - applicationName, destination, versionTag, deploymentStatus, user, lastChangeTime
      Returns:
      a list of objects corresponding application deployment package states

    • getFilterableFolders

      @GET @Path("filterable-folders") List<String> getFilterableFolders()
      Finds all available Application folders path list
      Returns:
      a list of Strings containing all available folder names