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
  `Facet`
  `createFacet(ConfigurationFacet configurationFacet)`
  `void`
  `deleteFacet(String facetId)`
  `Facet`
  `getFacet(String facetId)`
  `List<Descriptor>`
  `getFacetTypes(String baseType)`
  `Facet`
  `newFacet(String type)`
  `List<Facet>`
  `searchFacets(FacetFilters facetFilters)`
  `default String`
  `serviceName()`
  `Facet`
  `updateFacet(String facetId, ConfigurationFacet configurationFacet)`

- ## Method Details

  - ### serviceName

    default String serviceName()
    Specified by:
      `serviceName` in interface `ApiService`

  - ### getFacet

    @GET @Path("{facetId:.*Facet[^/-]*}") Facet getFacet(@PathParam("facetId") String facetId)

  - ### createFacet

    @POST Facet createFacet(ConfigurationFacet configurationFacet)

  - ### newFacet

    Facet newFacet(String type)

  - ### updateFacet

    @PUT @Path("{facetId:.*Facet[^/]*}") Facet updateFacet(@PathParam("facetId") String facetId, ConfigurationFacet configurationFacet)

  - ### deleteFacet

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

  - ### searchFacets

    @POST @Path("search") List<Facet> searchFacets(FacetFilters facetFilters)

  - ### getFacetTypes

    @GET @Path("types") List<Descriptor> getFacetTypes(@QueryParam("baseType") String baseType)