org.wso2.carbon.apimgt.rest.integration.tests.api

Class APICollectionApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.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 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 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 query, String accept, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
void	apisHead(String query, String accept, String ifNoneMatch) Check given API attibute name is already exist Using this operation, you can check a given API context is already used.
com.squareup.okhttp.Call	apisHeadAsync(String query, String accept, String ifNoneMatch, ApiCallback<Void> callback) Check given API attibute name is already exist (asynchronously) Using this operation, you can check a given API context is already used.
ApiResponse<Void>	apisHeadWithHttpInfo(String query, String accept, String ifNoneMatch) Check given API attibute name is already exist Using this operation, you can check a given API context is already used.
API	apisPost(API body, String contentType) Create a new API This operation can be used to create a new API specifying the details of the API in the payload.
com.squareup.okhttp.Call	apisPostAsync(API body, String contentType, ApiCallback<API> callback) Create a new API (asynchronously) This operation can be used to create a new API specifying the details of the API in the payload.
ApiResponse<API>	apisPostWithHttpInfo(API body, String contentType) Create a new API This operation can be used to create a new API specifying the details of the API in the payload.
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 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.

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)

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (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 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.

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)

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (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 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.

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)

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (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

apisHead

public void apisHead(String query,
                     String accept,
                     String ifNoneMatch)
              throws ApiException

Check given API attibute name is already exist Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (optional)

Throws:

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

apisHeadWithHttpInfo

public ApiResponse<Void> apisHeadWithHttpInfo(String query,
                                              String accept,
                                              String ifNoneMatch)
                                       throws ApiException

Check given API attibute name is already exist Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisHeadAsync

public com.squareup.okhttp.Call apisHeadAsync(String query,
                                              String accept,
                                              String ifNoneMatch,
                                              ApiCallback<Void> callback)
                                       throws ApiException

Check given API attibute name is already exist (asynchronously) Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

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, lifeCycleStatus, description, subcontext, doc, provider**] 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 resourec. (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

apisPost

public API apisPost(API body,
                    String contentType)
             throws ApiException

Create a new API This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

Returns:

API

Throws:

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

apisPostWithHttpInfo

public ApiResponse<API> apisPostWithHttpInfo(API body,
                                             String contentType)
                                      throws ApiException

Create a new API This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

Returns:

ApiResponse<API>

Throws:

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

apisPostAsync

public com.squareup.okhttp.Call apisPostAsync(API body,
                                              String contentType,
                                              ApiCallback<API> callback)
                                       throws ApiException

Create a new API (asynchronously) This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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