Package com.xebialabs.xlrelease.api.v1

Interface FacetApi

All Superinterfaces:

ApiService

@Path("/api/v1/facets/")
@Produces("application/json")
@Consumes("application/json")
public interface FacetApi
extends ApiService

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 Type	Method	Description
com.xebialabs.xlrelease.domain.facet.Facet	createFacet(com.xebialabs.xlrelease.domain.facet.ConfigurationFacet configurationFacet)
void	deleteFacet(java.lang.String facetId)
com.xebialabs.xlrelease.domain.facet.Facet	getFacet(java.lang.String facetId)
java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor>	getFacetTypes(java.lang.String baseType)
com.xebialabs.xlrelease.domain.facet.Facet	newFacet(java.lang.String type)
java.util.List<com.xebialabs.xlrelease.domain.facet.Facet>	searchFacets(com.xebialabs.xlrelease.api.v1.forms.FacetFilters facetFilters)
default java.lang.String	serviceName()
com.xebialabs.xlrelease.domain.facet.Facet	updateFacet(java.lang.String facetId, com.xebialabs.xlrelease.domain.facet.ConfigurationFacet configurationFacet)

Method Detail

serviceName

default java.lang.String serviceName()

Specified by:

serviceName in interface ApiService

getFacet

@GET
@Path("{facetId:.*Facet[^/-]*}")
com.xebialabs.xlrelease.domain.facet.Facet getFacet(@PathParam("facetId")
                                                    java.lang.String facetId)

createFacet

@POST
com.xebialabs.xlrelease.domain.facet.Facet createFacet(com.xebialabs.xlrelease.domain.facet.ConfigurationFacet configurationFacet)

newFacet

com.xebialabs.xlrelease.domain.facet.Facet newFacet(java.lang.String type)

updateFacet

@PUT
@Path("{facetId:.*Facet[^/]*}")
com.xebialabs.xlrelease.domain.facet.Facet updateFacet(@PathParam("facetId")
                                                       java.lang.String facetId,
                                                       com.xebialabs.xlrelease.domain.facet.ConfigurationFacet configurationFacet)

deleteFacet

@DELETE
@Path("{facetId:.*Facet[^/]*}")
void deleteFacet(@PathParam("facetId")
                 java.lang.String facetId)

searchFacets

@POST
@Path("search")
java.util.List<com.xebialabs.xlrelease.domain.facet.Facet> searchFacets(com.xebialabs.xlrelease.api.v1.forms.FacetFilters facetFilters)

getFacetTypes

@GET
@Path("types")
java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> getFacetTypes(@QueryParam("baseType")
                                                                                   java.lang.String baseType)