io.apiman.manager.api.rest.contract

Interface ISearchResource

@Path(value="search")
public interface ISearchResource

The Search API.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ApplicationSummaryBean>	searchApps(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Use this endpoint to search for applications.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.OrganizationSummaryBean>	searchOrgs(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Use this endpoint to search for organizations.
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ServiceSummaryBean>	searchServices(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria) Use this endpoint to search for services.

Method Detail

searchOrgs

@POST
@Path(value="organizations")
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.OrganizationSummaryBean> searchOrgs(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                             throws InvalidSearchCriteriaException

Use this endpoint to search for organizations. The search criteria is provided in the body of the request, including filters, order-by, and paging information.

Parameters:

criteria - The search criteria.

Returns:

The search results (a page of organizations).

Throws:

InvalidSearchCriteriaException - when provided criteria are invalid when provided criteria are invalid

searchApps

@POST
@Path(value="applications")
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ApplicationSummaryBean> searchApps(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                            throws OrganizationNotFoundException,
                                                                                                                                   InvalidSearchCriteriaException

Use this endpoint to search for applications. The search criteria is provided in the body of the request, including filters, order-by, and paging information.

Parameters:

criteria - The search criteria.

Returns:

The search results (a page of applications).

Throws:

OrganizationNotFoundException - when provided organization is not found

InvalidSearchCriteriaException - when provided criteria are invalid

searchServices

@POST
@Path(value="services")
@Consumes(value="application/json")
@Produces(value="application/json")
io.apiman.manager.api.beans.search.SearchResultsBean<io.apiman.manager.api.beans.summary.ServiceSummaryBean> searchServices(io.apiman.manager.api.beans.search.SearchCriteriaBean criteria)
                                                                                                                            throws OrganizationNotFoundException,
                                                                                                                                   InvalidSearchCriteriaException

Use this endpoint to search for services. The search criteria is provided in the body of the request, including filters, order-by, and paging information.

Parameters:

criteria - The search criteria.

Returns:

The search results (a page of services).

Throws:

OrganizationNotFoundException - when provided organization is not found

InvalidSearchCriteriaException - when provided criteria are invalid