org.wso2.carbon.apimgt.samples.utils.store.rest.client.api

Class APICollectionApi

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.store.rest.client.api.APICollectionApi

public class APICollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
APICollectionApi()
APICollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIList	apisGet(Integer limit, Integer offset, String xWSO2Tenant, String query, String accept, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
com.squareup.okhttp.Call	apisGetAsync(Integer limit, Integer offset, String xWSO2Tenant, String query, String accept, String ifNoneMatch, ApiCallback<APIList> callback) Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition.
ApiResponse<APIList>	apisGetWithHttpInfo(Integer limit, Integer offset, String xWSO2Tenant, String query, String accept, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

APICollectionApi

public APICollectionApi()

APICollectionApi

public APICollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisGet

public APIList apisGet(Integer limit,
                       Integer offset,
                       String xWSO2Tenant,
                       String query,
                       String accept,
                       String ifNoneMatch)
                throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retriving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

APIList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisGetWithHttpInfo

public ApiResponse<APIList> apisGetWithHttpInfo(Integer limit,
                                                Integer offset,
                                                String xWSO2Tenant,
                                                String query,
                                                String accept,
                                                String ifNoneMatch)
                                         throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retriving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<APIList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisGetAsync

public com.squareup.okhttp.Call apisGetAsync(Integer limit,
                                             Integer offset,
                                             String xWSO2Tenant,
                                             String query,
                                             String accept,
                                             String ifNoneMatch,
                                             ApiCallback<APIList> callback)
                                      throws ApiException

Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retriving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object