Class ApIsApi
- java.lang.Object
-
- org.wso2.am.integration.clients.publisher.api.v1.ApIsApi
-
public class ApIsApi extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapisApiIdAsyncapiGet(String apiId, String ifNoneMatch)Get AsyncAPI definition This operation can be used to retrieve the AsyncAPI definition of an API.okhttp3.CallapisApiIdAsyncapiGetAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback)Get AsyncAPI definition (asynchronously) This operation can be used to retrieve the AsyncAPI definition of an API.okhttp3.CallapisApiIdAsyncapiGetCall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for apisApiIdAsyncapiGetApiResponse<String>apisApiIdAsyncapiGetWithHttpInfo(String apiId, String ifNoneMatch)Get AsyncAPI definition This operation can be used to retrieve the AsyncAPI definition of an API.StringapisApiIdAsyncapiPut(String apiId, String ifMatch, String apiDefinition, String url, File file)Update AsyncAPI definition This operation can be used to update the AsyncAPI definition of an existing API.okhttp3.CallapisApiIdAsyncapiPutAsync(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback<String> _callback)Update AsyncAPI definition (asynchronously) This operation can be used to update the AsyncAPI definition of an existing API.okhttp3.CallapisApiIdAsyncapiPutCall(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback _callback)Build call for apisApiIdAsyncapiPutApiResponse<String>apisApiIdAsyncapiPutWithHttpInfo(String apiId, String ifMatch, String apiDefinition, String url, File file)Update AsyncAPI definition This operation can be used to update the AsyncAPI definition of an existing API.Map<String,String>apisApiIdEnvironmentsEnvIdKeysGet(String apiId, String envId)get environment specific API properties This operation can be used to retrieve environment specific API properties from an existing API.okhttp3.CallapisApiIdEnvironmentsEnvIdKeysGetAsync(String apiId, String envId, ApiCallback<Map<String,String>> _callback)get environment specific API properties (asynchronously) This operation can be used to retrieve environment specific API properties from an existing API.okhttp3.CallapisApiIdEnvironmentsEnvIdKeysGetCall(String apiId, String envId, ApiCallback _callback)Build call for apisApiIdEnvironmentsEnvIdKeysGetApiResponse<Map<String,String>>apisApiIdEnvironmentsEnvIdKeysGetWithHttpInfo(String apiId, String envId)get environment specific API properties This operation can be used to retrieve environment specific API properties from an existing API.Map<String,String>apisApiIdEnvironmentsEnvIdKeysPut(String apiId, String envId, Map<String,String> requestBody)Update environment specific API properties This operation can be used to update the environment specific API properties of an existing API.okhttp3.CallapisApiIdEnvironmentsEnvIdKeysPutAsync(String apiId, String envId, Map<String,String> requestBody, ApiCallback<Map<String,String>> _callback)Update environment specific API properties (asynchronously) This operation can be used to update the environment specific API properties of an existing API.okhttp3.CallapisApiIdEnvironmentsEnvIdKeysPutCall(String apiId, String envId, Map<String,String> requestBody, ApiCallback _callback)Build call for apisApiIdEnvironmentsEnvIdKeysPutApiResponse<Map<String,String>>apisApiIdEnvironmentsEnvIdKeysPutWithHttpInfo(String apiId, String envId, Map<String,String> requestBody)Update environment specific API properties This operation can be used to update the environment specific API properties of an existing API.APIDTOcreateAPI(APIDTO APIDTO, String openAPIVersion)Create a New API This operation can be used to create a new API specifying the details of the API in the payload.okhttp3.CallcreateAPIAsync(APIDTO APIDTO, String openAPIVersion, ApiCallback<APIDTO> _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.okhttp3.CallcreateAPICall(APIDTO APIDTO, String openAPIVersion, ApiCallback _callback)Build call for createAPIApiResponse<APIDTO>createAPIWithHttpInfo(APIDTO APIDTO, String openAPIVersion)Create a New API This operation can be used to create a new API specifying the details of the API in the payload.APIDTOcreateNewAPIVersion(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion)Create a New API Version This operation can be used to create a new version of an existing API.okhttp3.CallcreateNewAPIVersionAsync(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion, ApiCallback<APIDTO> _callback)Create a New API Version (asynchronously) This operation can be used to create a new version of an existing API.okhttp3.CallcreateNewAPIVersionCall(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion, ApiCallback _callback)Build call for createNewAPIVersionApiResponse<APIDTO>createNewAPIVersionWithHttpInfo(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion)Create a New API Version This operation can be used to create a new version of an existing API.voiddeleteAPI(String apiId, String ifMatch)Delete an API This operation can be used to delete an existing API proving the Id of the API.okhttp3.CalldeleteAPIAsync(String apiId, String ifMatch, ApiCallback<Void> _callback)Delete an API (asynchronously) This operation can be used to delete an existing API proving the Id of the API.okhttp3.CalldeleteAPICall(String apiId, String ifMatch, ApiCallback _callback)Build call for deleteAPIApiResponse<Void>deleteAPIWithHttpInfo(String apiId, String ifMatch)Delete an API This operation can be used to delete an existing API proving the Id of the API.APIKeyDTOgenerateInternalAPIKey(String apiId)Generate internal API Key to invoke APIS.okhttp3.CallgenerateInternalAPIKeyAsync(String apiId, ApiCallback<APIKeyDTO> _callback)Generate internal API Key to invoke APIS.okhttp3.CallgenerateInternalAPIKeyCall(String apiId, ApiCallback _callback)Build call for generateInternalAPIKeyApiResponse<APIKeyDTO>generateInternalAPIKeyWithHttpInfo(String apiId)Generate internal API Key to invoke APIS.StringgenerateMockScripts(String apiId, String ifNoneMatch)Generate Mock Response Payloads This operation can be used to generate mock responses from examples of swagger definition of an API.okhttp3.CallgenerateMockScriptsAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback)Generate Mock Response Payloads (asynchronously) This operation can be used to generate mock responses from examples of swagger definition of an API.okhttp3.CallgenerateMockScriptsCall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for generateMockScriptsApiResponse<String>generateMockScriptsWithHttpInfo(String apiId, String ifNoneMatch)Generate Mock Response Payloads This operation can be used to generate mock responses from examples of swagger definition of an API.APIListDTOgetAllAPIs(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept)Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.okhttp3.CallgetAllAPIsAsync(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept, ApiCallback<APIListDTO> _callback)Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition.okhttp3.CallgetAllAPIsCall(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept, ApiCallback _callback)Build call for getAllAPIsApiResponse<APIListDTO>getAllAPIsWithHttpInfo(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept)Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.APIDTOgetAPI(String apiId, String xWSO2Tenant, String ifNoneMatch)Get Details of an API Using this operation, you can retrieve complete details of a single API.okhttp3.CallgetAPIAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<APIDTO> _callback)Get Details of an API (asynchronously) Using this operation, you can retrieve complete details of a single API.okhttp3.CallgetAPICall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback)Build call for getAPIApiClientgetApiClient()ResourcePathListDTOgetAPIResourcePaths(String apiId, Integer limit, Integer offset, String ifNoneMatch)Get Resource Paths of an API This operation can be used to retrieve resource paths defined for a specific api.okhttp3.CallgetAPIResourcePathsAsync(String apiId, Integer limit, Integer offset, String ifNoneMatch, ApiCallback<ResourcePathListDTO> _callback)Get Resource Paths of an API (asynchronously) This operation can be used to retrieve resource paths defined for a specific api.okhttp3.CallgetAPIResourcePathsCall(String apiId, Integer limit, Integer offset, String ifNoneMatch, ApiCallback _callback)Build call for getAPIResourcePathsApiResponse<ResourcePathListDTO>getAPIResourcePathsWithHttpInfo(String apiId, Integer limit, Integer offset, String ifNoneMatch)Get Resource Paths of an API This operation can be used to retrieve resource paths defined for a specific api.ThrottlingPolicyDTOgetAPISubscriptionPolicies(String apiId, String xWSO2Tenant, String ifNoneMatch)Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.okhttp3.CallgetAPISubscriptionPoliciesAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<ThrottlingPolicyDTO> _callback)Get Details of the Subscription Throttling Policies of an API (asynchronously) This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.okhttp3.CallgetAPISubscriptionPoliciesCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback)Build call for getAPISubscriptionPoliciesApiResponse<ThrottlingPolicyDTO>getAPISubscriptionPoliciesWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch)Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.StringgetAPISwagger(String apiId, String ifNoneMatch)Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.okhttp3.CallgetAPISwaggerAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback)Get Swagger Definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.okhttp3.CallgetAPISwaggerCall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for getAPISwaggerApiResponse<String>getAPISwaggerWithHttpInfo(String apiId, String ifNoneMatch)Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.voidgetAPIThumbnail(String apiId, String ifNoneMatch)Get Thumbnail Image This operation can be used to download a thumbnail image of an API.okhttp3.CallgetAPIThumbnailAsync(String apiId, String ifNoneMatch, ApiCallback<Void> _callback)Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API.okhttp3.CallgetAPIThumbnailCall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for getAPIThumbnailApiResponse<Void>getAPIThumbnailWithHttpInfo(String apiId, String ifNoneMatch)Get Thumbnail Image This operation can be used to download a thumbnail image of an API.ApiResponse<APIDTO>getAPIWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch)Get Details of an API Using this operation, you can retrieve complete details of a single API.MockResponsePayloadListDTOgetGeneratedMockScriptsOfAPI(String apiId, String ifNoneMatch)Get Generated Mock Response Payloads This operation can be used to get generated mock responses from examples of swagger definition of an API.okhttp3.CallgetGeneratedMockScriptsOfAPIAsync(String apiId, String ifNoneMatch, ApiCallback<MockResponsePayloadListDTO> _callback)Get Generated Mock Response Payloads (asynchronously) This operation can be used to get generated mock responses from examples of swagger definition of an API.okhttp3.CallgetGeneratedMockScriptsOfAPICall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for getGeneratedMockScriptsOfAPIApiResponse<MockResponsePayloadListDTO>getGeneratedMockScriptsOfAPIWithHttpInfo(String apiId, String ifNoneMatch)Get Generated Mock Response Payloads This operation can be used to get generated mock responses from examples of swagger definition of an API.WSDLInfoDTOgetWSDLInfoOfAPI(String apiId)Get WSDL Meta Information This operation can be used to retrieve the WSDL meta information of an API.okhttp3.CallgetWSDLInfoOfAPIAsync(String apiId, ApiCallback<WSDLInfoDTO> _callback)Get WSDL Meta Information (asynchronously) This operation can be used to retrieve the WSDL meta information of an API.okhttp3.CallgetWSDLInfoOfAPICall(String apiId, ApiCallback _callback)Build call for getWSDLInfoOfAPIApiResponse<WSDLInfoDTO>getWSDLInfoOfAPIWithHttpInfo(String apiId)Get WSDL Meta Information This operation can be used to retrieve the WSDL meta information of an API.voidgetWSDLOfAPI(String apiId, String ifNoneMatch)Get WSDL definition This operation can be used to retrieve the WSDL definition of an API.okhttp3.CallgetWSDLOfAPIAsync(String apiId, String ifNoneMatch, ApiCallback<Void> _callback)Get WSDL definition (asynchronously) This operation can be used to retrieve the WSDL definition of an API.okhttp3.CallgetWSDLOfAPICall(String apiId, String ifNoneMatch, ApiCallback _callback)Build call for getWSDLOfAPIApiResponse<Void>getWSDLOfAPIWithHttpInfo(String apiId, String ifNoneMatch)Get WSDL definition This operation can be used to retrieve the WSDL definition of an API.APIDTOimportAsyncAPISpecification(File file, String url, String additionalProperties)import an AsyncAPI Specification This operation can be used to create and API from the AsyncAPI Specification.okhttp3.CallimportAsyncAPISpecificationAsync(File file, String url, String additionalProperties, ApiCallback<APIDTO> _callback)import an AsyncAPI Specification (asynchronously) This operation can be used to create and API from the AsyncAPI Specification.okhttp3.CallimportAsyncAPISpecificationCall(File file, String url, String additionalProperties, ApiCallback _callback)Build call for importAsyncAPISpecificationApiResponse<APIDTO>importAsyncAPISpecificationWithHttpInfo(File file, String url, String additionalProperties)import an AsyncAPI Specification This operation can be used to create and API from the AsyncAPI Specification.APIDTOimportGraphQLSchema(String ifMatch, String type, File file, String additionalProperties)Import a GraphQL SDL This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL Schemaokhttp3.CallimportGraphQLSchemaAsync(String ifMatch, String type, File file, String additionalProperties, ApiCallback<APIDTO> _callback)Import a GraphQL SDL (asynchronously) This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL Schemaokhttp3.CallimportGraphQLSchemaCall(String ifMatch, String type, File file, String additionalProperties, ApiCallback _callback)Build call for importGraphQLSchemaApiResponse<APIDTO>importGraphQLSchemaWithHttpInfo(String ifMatch, String type, File file, String additionalProperties)Import a GraphQL SDL This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL SchemaAPIDTOimportOpenAPIDefinition(File file, String url, String additionalProperties, String inlineAPIDefinition)Import an OpenAPI Definition This operation can be used to create an API from an OpenAPI definition.okhttp3.CallimportOpenAPIDefinitionAsync(File file, String url, String additionalProperties, String inlineAPIDefinition, ApiCallback<APIDTO> _callback)Import an OpenAPI Definition (asynchronously) This operation can be used to create an API from an OpenAPI definition.okhttp3.CallimportOpenAPIDefinitionCall(File file, String url, String additionalProperties, String inlineAPIDefinition, ApiCallback _callback)Build call for importOpenAPIDefinitionApiResponse<APIDTO>importOpenAPIDefinitionWithHttpInfo(File file, String url, String additionalProperties, String inlineAPIDefinition)Import an OpenAPI Definition This operation can be used to create an API from an OpenAPI definition.APIDTOimportServiceFromCatalog(String serviceKey, APIDTO APIDTO)Import a Service from Service Catalog This operation can be used to create an API from a Service from Service Catalogokhttp3.CallimportServiceFromCatalogAsync(String serviceKey, APIDTO APIDTO, ApiCallback<APIDTO> _callback)Import a Service from Service Catalog (asynchronously) This operation can be used to create an API from a Service from Service Catalogokhttp3.CallimportServiceFromCatalogCall(String serviceKey, APIDTO APIDTO, ApiCallback _callback)Build call for importServiceFromCatalogApiResponse<APIDTO>importServiceFromCatalogWithHttpInfo(String serviceKey, APIDTO APIDTO)Import a Service from Service Catalog This operation can be used to create an API from a Service from Service CatalogAPIDTOimportWSDLDefinition(File file, String url, String additionalProperties, String implementationType)Import a WSDL Definition This operation can be used to create an API using a WSDL definition.okhttp3.CallimportWSDLDefinitionAsync(File file, String url, String additionalProperties, String implementationType, ApiCallback<APIDTO> _callback)Import a WSDL Definition (asynchronously) This operation can be used to create an API using a WSDL definition.okhttp3.CallimportWSDLDefinitionCall(File file, String url, String additionalProperties, String implementationType, ApiCallback _callback)Build call for importWSDLDefinitionApiResponse<APIDTO>importWSDLDefinitionWithHttpInfo(File file, String url, String additionalProperties, String implementationType)Import a WSDL Definition This operation can be used to create an API using a WSDL definition.APIDTOreimportServiceFromCatalog(String apiId)Update the Service that is used to create the API This operation can be used to re-import the Service used to create the APIokhttp3.CallreimportServiceFromCatalogAsync(String apiId, ApiCallback<APIDTO> _callback)Update the Service that is used to create the API (asynchronously) This operation can be used to re-import the Service used to create the APIokhttp3.CallreimportServiceFromCatalogCall(String apiId, ApiCallback _callback)Build call for reimportServiceFromCatalogApiResponse<APIDTO>reimportServiceFromCatalogWithHttpInfo(String apiId)Update the Service that is used to create the API This operation can be used to re-import the Service used to create the APIvoidsetApiClient(ApiClient apiClient)APIDTOupdateAPI(String apiId, APIDTO APIDTO, String ifMatch)Update an API This operation can be used to update an existing API.okhttp3.CallupdateAPIAsync(String apiId, APIDTO APIDTO, String ifMatch, ApiCallback<APIDTO> _callback)Update an API (asynchronously) This operation can be used to update an existing API.okhttp3.CallupdateAPICall(String apiId, APIDTO APIDTO, String ifMatch, ApiCallback _callback)Build call for updateAPIStringupdateAPISwagger(String apiId, String ifMatch, String apiDefinition, String url, File file)Update Swagger Definition This operation can be used to update the swagger definition of an existing API.okhttp3.CallupdateAPISwaggerAsync(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback<String> _callback)Update Swagger Definition (asynchronously) This operation can be used to update the swagger definition of an existing API.okhttp3.CallupdateAPISwaggerCall(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback _callback)Build call for updateAPISwaggerApiResponse<String>updateAPISwaggerWithHttpInfo(String apiId, String ifMatch, String apiDefinition, String url, File file)Update Swagger Definition This operation can be used to update the swagger definition of an existing API.FileInfoDTOupdateAPIThumbnail(String apiId, File file, String ifMatch)Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API.okhttp3.CallupdateAPIThumbnailAsync(String apiId, File file, String ifMatch, ApiCallback<FileInfoDTO> _callback)Upload a Thumbnail Image (asynchronously) This operation can be used to upload a thumbnail image of an API.okhttp3.CallupdateAPIThumbnailCall(String apiId, File file, String ifMatch, ApiCallback _callback)Build call for updateAPIThumbnailApiResponse<FileInfoDTO>updateAPIThumbnailWithHttpInfo(String apiId, File file, String ifMatch)Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API.ApiResponse<APIDTO>updateAPIWithHttpInfo(String apiId, APIDTO APIDTO, String ifMatch)Update an API This operation can be used to update an existing API.APIDTOupdateTopics(String apiId, TopicListDTO topicListDTO, String ifMatch)Update Topics This operation can be used to update topics of an existing API.okhttp3.CallupdateTopicsAsync(String apiId, TopicListDTO topicListDTO, String ifMatch, ApiCallback<APIDTO> _callback)Update Topics (asynchronously) This operation can be used to update topics of an existing API.okhttp3.CallupdateTopicsCall(String apiId, TopicListDTO topicListDTO, String ifMatch, ApiCallback _callback)Build call for updateTopicsApiResponse<APIDTO>updateTopicsWithHttpInfo(String apiId, TopicListDTO topicListDTO, String ifMatch)Update Topics This operation can be used to update topics of an existing API.voidupdateWSDLOfAPI(String apiId, String ifMatch, File file, String url)Update WSDL Definition This operation can be used to update the WSDL definition of an existing API.okhttp3.CallupdateWSDLOfAPIAsync(String apiId, String ifMatch, File file, String url, ApiCallback<Void> _callback)Update WSDL Definition (asynchronously) This operation can be used to update the WSDL definition of an existing API.okhttp3.CallupdateWSDLOfAPICall(String apiId, String ifMatch, File file, String url, ApiCallback _callback)Build call for updateWSDLOfAPIApiResponse<Void>updateWSDLOfAPIWithHttpInfo(String apiId, String ifMatch, File file, String url)Update WSDL Definition This operation can be used to update the WSDL definition of an existing API.
-
-
-
Constructor Detail
-
ApIsApi
public ApIsApi()
-
ApIsApi
public ApIsApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
apisApiIdAsyncapiGetCall
public okhttp3.Call apisApiIdAsyncapiGetCall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for apisApiIdAsyncapiGet- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
apisApiIdAsyncapiGet
public String apisApiIdAsyncapiGet(String apiId, String ifNoneMatch) throws ApiException
Get AsyncAPI definition This operation can be used to retrieve the AsyncAPI definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdAsyncapiGetWithHttpInfo
public ApiResponse<String> apisApiIdAsyncapiGetWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Get AsyncAPI definition This operation can be used to retrieve the AsyncAPI definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdAsyncapiGetAsync
public okhttp3.Call apisApiIdAsyncapiGetAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback) throws ApiException
Get AsyncAPI definition (asynchronously) This operation can be used to retrieve the AsyncAPI definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
apisApiIdAsyncapiPutCall
public okhttp3.Call apisApiIdAsyncapiPutCall(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback _callback) throws ApiException
Build call for apisApiIdAsyncapiPut- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- AsyncAPI definition of the API (optional)url- AsyncAPI definition URL of the API (optional)file- AsyncAPI definition as a file (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
apisApiIdAsyncapiPut
public String apisApiIdAsyncapiPut(String apiId, String ifMatch, String apiDefinition, String url, File file) throws ApiException
Update AsyncAPI definition This operation can be used to update the AsyncAPI definition of an existing API. AsyncAPI definition to be updated is passed as a form data parameter 'apiDefinition'.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- AsyncAPI definition of the API (optional)url- AsyncAPI definition URL of the API (optional)file- AsyncAPI definition as a file (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdAsyncapiPutWithHttpInfo
public ApiResponse<String> apisApiIdAsyncapiPutWithHttpInfo(String apiId, String ifMatch, String apiDefinition, String url, File file) throws ApiException
Update AsyncAPI definition This operation can be used to update the AsyncAPI definition of an existing API. AsyncAPI definition to be updated is passed as a form data parameter 'apiDefinition'.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- AsyncAPI definition of the API (optional)url- AsyncAPI definition URL of the API (optional)file- AsyncAPI definition as a file (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdAsyncapiPutAsync
public okhttp3.Call apisApiIdAsyncapiPutAsync(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback<String> _callback) throws ApiException
Update AsyncAPI definition (asynchronously) This operation can be used to update the AsyncAPI definition of an existing API. AsyncAPI definition to be updated is passed as a form data parameter 'apiDefinition'.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- AsyncAPI definition of the API (optional)url- AsyncAPI definition URL of the API (optional)file- AsyncAPI definition as a file (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
-
apisApiIdEnvironmentsEnvIdKeysGetCall
public okhttp3.Call apisApiIdEnvironmentsEnvIdKeysGetCall(String apiId, String envId, ApiCallback _callback) throws ApiException
Build call for apisApiIdEnvironmentsEnvIdKeysGet- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
apisApiIdEnvironmentsEnvIdKeysGet
public Map<String,String> apisApiIdEnvironmentsEnvIdKeysGet(String apiId, String envId) throws ApiException
get environment specific API properties This operation can be used to retrieve environment specific API properties from an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)- Returns:
- Map<String, String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdEnvironmentsEnvIdKeysGetWithHttpInfo
public ApiResponse<Map<String,String>> apisApiIdEnvironmentsEnvIdKeysGetWithHttpInfo(String apiId, String envId) throws ApiException
get environment specific API properties This operation can be used to retrieve environment specific API properties from an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)- Returns:
- ApiResponse<Map<String, String>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdEnvironmentsEnvIdKeysGetAsync
public okhttp3.Call apisApiIdEnvironmentsEnvIdKeysGetAsync(String apiId, String envId, ApiCallback<Map<String,String>> _callback) throws ApiException
get environment specific API properties (asynchronously) This operation can be used to retrieve environment specific API properties from an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (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
-
apisApiIdEnvironmentsEnvIdKeysPutCall
public okhttp3.Call apisApiIdEnvironmentsEnvIdKeysPutCall(String apiId, String envId, Map<String,String> requestBody, ApiCallback _callback) throws ApiException
Build call for apisApiIdEnvironmentsEnvIdKeysPut- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)requestBody- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
apisApiIdEnvironmentsEnvIdKeysPut
public Map<String,String> apisApiIdEnvironmentsEnvIdKeysPut(String apiId, String envId, Map<String,String> requestBody) throws ApiException
Update environment specific API properties This operation can be used to update the environment specific API properties of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)requestBody- (required)- Returns:
- Map<String, String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdEnvironmentsEnvIdKeysPutWithHttpInfo
public ApiResponse<Map<String,String>> apisApiIdEnvironmentsEnvIdKeysPutWithHttpInfo(String apiId, String envId, Map<String,String> requestBody) throws ApiException
Update environment specific API properties This operation can be used to update the environment specific API properties of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)requestBody- (required)- Returns:
- ApiResponse<Map<String, String>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
apisApiIdEnvironmentsEnvIdKeysPutAsync
public okhttp3.Call apisApiIdEnvironmentsEnvIdKeysPutAsync(String apiId, String envId, Map<String,String> requestBody, ApiCallback<Map<String,String>> _callback) throws ApiException
Update environment specific API properties (asynchronously) This operation can be used to update the environment specific API properties of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)envId- **Env ID** consisting of the **UUID** of the gateway environment. (required)requestBody- (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
-
createAPICall
public okhttp3.Call createAPICall(APIDTO APIDTO, String openAPIVersion, ApiCallback _callback) throws ApiException
Build call for createAPI- Parameters:
APIDTO- API object that needs to be added (required)openAPIVersion- Open api version (optional, default to v3)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createAPI
public APIDTO createAPI(APIDTO APIDTO, String openAPIVersion) 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:
APIDTO- API object that needs to be added (required)openAPIVersion- Open api version (optional, default to v3)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createAPIWithHttpInfo
public ApiResponse<APIDTO> createAPIWithHttpInfo(APIDTO APIDTO, String openAPIVersion) 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:
APIDTO- API object that needs to be added (required)openAPIVersion- Open api version (optional, default to v3)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createAPIAsync
public okhttp3.Call createAPIAsync(APIDTO APIDTO, String openAPIVersion, ApiCallback<APIDTO> _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:
APIDTO- API object that needs to be added (required)openAPIVersion- Open api version (optional, default to v3)_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
-
createNewAPIVersionCall
public okhttp3.Call createNewAPIVersionCall(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion, ApiCallback _callback) throws ApiException
Build call for createNewAPIVersion- Parameters:
newVersion- Version of the new API. (required)apiId- **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API should be added as default version. (optional, default to false)serviceVersion- Version of the Service that will used in creating new version (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createNewAPIVersion
public APIDTO createNewAPIVersion(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion) throws ApiException
Create a New API Version This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.- Parameters:
newVersion- Version of the new API. (required)apiId- **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API should be added as default version. (optional, default to false)serviceVersion- Version of the Service that will used in creating new version (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createNewAPIVersionWithHttpInfo
public ApiResponse<APIDTO> createNewAPIVersionWithHttpInfo(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion) throws ApiException
Create a New API Version This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.- Parameters:
newVersion- Version of the new API. (required)apiId- **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API should be added as default version. (optional, default to false)serviceVersion- Version of the Service that will used in creating new version (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createNewAPIVersionAsync
public okhttp3.Call createNewAPIVersionAsync(String newVersion, String apiId, Boolean defaultVersion, String serviceVersion, ApiCallback<APIDTO> _callback) throws ApiException
Create a New API Version (asynchronously) This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.- Parameters:
newVersion- Version of the new API. (required)apiId- **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API should be added as default version. (optional, default to false)serviceVersion- Version of the Service that will used in creating new version (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
-
deleteAPICall
public okhttp3.Call deleteAPICall(String apiId, String ifMatch, ApiCallback _callback) throws ApiException
Build call for deleteAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteAPI
public void deleteAPI(String apiId, String ifMatch) throws ApiException
Delete an API This operation can be used to delete an existing API proving the Id of the API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteAPIWithHttpInfo
public ApiResponse<Void> deleteAPIWithHttpInfo(String apiId, String ifMatch) throws ApiException
Delete an API This operation can be used to delete an existing API proving the Id of the API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteAPIAsync
public okhttp3.Call deleteAPIAsync(String apiId, String ifMatch, ApiCallback<Void> _callback) throws ApiException
Delete an API (asynchronously) This operation can be used to delete an existing API proving the Id of the API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
generateInternalAPIKeyCall
public okhttp3.Call generateInternalAPIKeyCall(String apiId, ApiCallback _callback) throws ApiException
Build call for generateInternalAPIKey- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
generateInternalAPIKey
public APIKeyDTO generateInternalAPIKey(String apiId) throws ApiException
Generate internal API Key to invoke APIS. This operation can be used to generate internal api key which used to invoke API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- APIKeyDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
generateInternalAPIKeyWithHttpInfo
public ApiResponse<APIKeyDTO> generateInternalAPIKeyWithHttpInfo(String apiId) throws ApiException
Generate internal API Key to invoke APIS. This operation can be used to generate internal api key which used to invoke API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- ApiResponse<APIKeyDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
generateInternalAPIKeyAsync
public okhttp3.Call generateInternalAPIKeyAsync(String apiId, ApiCallback<APIKeyDTO> _callback) throws ApiException
Generate internal API Key to invoke APIS. (asynchronously) This operation can be used to generate internal api key which used to invoke API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (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
-
generateMockScriptsCall
public okhttp3.Call generateMockScriptsCall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for generateMockScripts- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
generateMockScripts
public String generateMockScripts(String apiId, String ifNoneMatch) throws ApiException
Generate Mock Response Payloads This operation can be used to generate mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
generateMockScriptsWithHttpInfo
public ApiResponse<String> generateMockScriptsWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Generate Mock Response Payloads This operation can be used to generate mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
generateMockScriptsAsync
public okhttp3.Call generateMockScriptsAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback) throws ApiException
Generate Mock Response Payloads (asynchronously) This operation can be used to generate mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
getAPICall
public okhttp3.Call getAPICall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPI
public APIDTO getAPI(String apiId, String xWSO2Tenant, String ifNoneMatch) throws ApiException
Get Details of an API Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIWithHttpInfo
public ApiResponse<APIDTO> getAPIWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) throws ApiException
Get Details of an API Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIAsync
public okhttp3.Call getAPIAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<APIDTO> _callback) throws ApiException
Get Details of an API (asynchronously) Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)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
-
getAPIResourcePathsCall
public okhttp3.Call getAPIResourcePathsCall(String apiId, Integer limit, Integer offset, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getAPIResourcePaths- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPIResourcePaths
public ResourcePathListDTO getAPIResourcePaths(String apiId, Integer limit, Integer offset, String ifNoneMatch) throws ApiException
Get Resource Paths of an API This operation can be used to retrieve resource paths defined for a specific api.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ResourcePathListDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIResourcePathsWithHttpInfo
public ApiResponse<ResourcePathListDTO> getAPIResourcePathsWithHttpInfo(String apiId, Integer limit, Integer offset, String ifNoneMatch) throws ApiException
Get Resource Paths of an API This operation can be used to retrieve resource paths defined for a specific api.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<ResourcePathListDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIResourcePathsAsync
public okhttp3.Call getAPIResourcePathsAsync(String apiId, Integer limit, Integer offset, String ifNoneMatch, ApiCallback<ResourcePathListDTO> _callback) throws ApiException
Get Resource Paths of an API (asynchronously) This operation can be used to retrieve resource paths defined for a specific api.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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)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
-
getAPISubscriptionPoliciesCall
public okhttp3.Call getAPISubscriptionPoliciesCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getAPISubscriptionPolicies- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPISubscriptionPolicies
public ThrottlingPolicyDTO getAPISubscriptionPolicies(String apiId, String xWSO2Tenant, String ifNoneMatch) throws ApiException
Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ThrottlingPolicyDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPISubscriptionPoliciesWithHttpInfo
public ApiResponse<ThrottlingPolicyDTO> getAPISubscriptionPoliciesWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) throws ApiException
Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<ThrottlingPolicyDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPISubscriptionPoliciesAsync
public okhttp3.Call getAPISubscriptionPoliciesAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<ThrottlingPolicyDTO> _callback) throws ApiException
Get Details of the Subscription Throttling Policies of an API (asynchronously) This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)xWSO2Tenant- For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)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
-
getAPISwaggerCall
public okhttp3.Call getAPISwaggerCall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getAPISwagger- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPISwagger
public String getAPISwagger(String apiId, String ifNoneMatch) throws ApiException
Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPISwaggerWithHttpInfo
public ApiResponse<String> getAPISwaggerWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPISwaggerAsync
public okhttp3.Call getAPISwaggerAsync(String apiId, String ifNoneMatch, ApiCallback<String> _callback) throws ApiException
Get Swagger Definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
getAPIThumbnailCall
public okhttp3.Call getAPIThumbnailCall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getAPIThumbnail- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPIThumbnail
public void getAPIThumbnail(String apiId, String ifNoneMatch) throws ApiException
Get Thumbnail Image This operation can be used to download a thumbnail image of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIThumbnailWithHttpInfo
public ApiResponse<Void> getAPIThumbnailWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Get Thumbnail Image This operation can be used to download a thumbnail image of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIThumbnailAsync
public okhttp3.Call getAPIThumbnailAsync(String apiId, String ifNoneMatch, ApiCallback<Void> _callback) throws ApiException
Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
getAllAPIsCall
public okhttp3.Call getAllAPIsCall(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept, ApiCallback _callback) throws ApiException
Build call for getAllAPIs- 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)sortBy- Criteria for sorting. (optional, default to createdTime)sortOrder- Order of sorting(ascending/descending). (optional, default to desc)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 contains \"wso2\". \"provider:\"wso2\"\" will match an API if the provider of the API is exactly \"wso2\". \"status:PUBLISHED\" will match an API if the API is in PUBLISHED state. Also you can use combined modifiers Eg. name:pizzashack version:v1 will match an API if the name of the API is pizzashack and version is v1. Supported attribute modifiers are [**version, context, name, status, description, doc, provider**] If no advanced attribute modifier has been specified, the API names containing the search term will be returned as a result. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAllAPIs
public APIListDTO getAllAPIs(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept) 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)sortBy- Criteria for sorting. (optional, default to createdTime)sortOrder- Order of sorting(ascending/descending). (optional, default to desc)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 contains \"wso2\". \"provider:\"wso2\"\" will match an API if the provider of the API is exactly \"wso2\". \"status:PUBLISHED\" will match an API if the API is in PUBLISHED state. Also you can use combined modifiers Eg. name:pizzashack version:v1 will match an API if the name of the API is pizzashack and version is v1. Supported attribute modifiers are [**version, context, name, status, description, doc, provider**] If no advanced attribute modifier has been specified, the API names containing the search term will be returned as a result. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")- Returns:
- APIListDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAllAPIsWithHttpInfo
public ApiResponse<APIListDTO> getAllAPIsWithHttpInfo(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept) 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)sortBy- Criteria for sorting. (optional, default to createdTime)sortOrder- Order of sorting(ascending/descending). (optional, default to desc)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 contains \"wso2\". \"provider:\"wso2\"\" will match an API if the provider of the API is exactly \"wso2\". \"status:PUBLISHED\" will match an API if the API is in PUBLISHED state. Also you can use combined modifiers Eg. name:pizzashack version:v1 will match an API if the name of the API is pizzashack and version is v1. Supported attribute modifiers are [**version, context, name, status, description, doc, provider**] If no advanced attribute modifier has been specified, the API names containing the search term will be returned as a result. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")- Returns:
- ApiResponse<APIListDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAllAPIsAsync
public okhttp3.Call getAllAPIsAsync(Integer limit, Integer offset, String sortBy, String sortOrder, String xWSO2Tenant, String query, String ifNoneMatch, String accept, ApiCallback<APIListDTO> _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)sortBy- Criteria for sorting. (optional, default to createdTime)sortOrder- Order of sorting(ascending/descending). (optional, default to desc)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 contains \"wso2\". \"provider:\"wso2\"\" will match an API if the provider of the API is exactly \"wso2\". \"status:PUBLISHED\" will match an API if the API is in PUBLISHED state. Also you can use combined modifiers Eg. name:pizzashack version:v1 will match an API if the name of the API is pizzashack and version is v1. Supported attribute modifiers are [**version, context, name, status, description, doc, provider**] If no advanced attribute modifier has been specified, the API names containing the search term will be returned as a result. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (optional)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")_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
-
getGeneratedMockScriptsOfAPICall
public okhttp3.Call getGeneratedMockScriptsOfAPICall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getGeneratedMockScriptsOfAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getGeneratedMockScriptsOfAPI
public MockResponsePayloadListDTO getGeneratedMockScriptsOfAPI(String apiId, String ifNoneMatch) throws ApiException
Get Generated Mock Response Payloads This operation can be used to get generated mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- MockResponsePayloadListDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getGeneratedMockScriptsOfAPIWithHttpInfo
public ApiResponse<MockResponsePayloadListDTO> getGeneratedMockScriptsOfAPIWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Get Generated Mock Response Payloads This operation can be used to get generated mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<MockResponsePayloadListDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getGeneratedMockScriptsOfAPIAsync
public okhttp3.Call getGeneratedMockScriptsOfAPIAsync(String apiId, String ifNoneMatch, ApiCallback<MockResponsePayloadListDTO> _callback) throws ApiException
Get Generated Mock Response Payloads (asynchronously) This operation can be used to get generated mock responses from examples of swagger definition of an API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
getWSDLInfoOfAPICall
public okhttp3.Call getWSDLInfoOfAPICall(String apiId, ApiCallback _callback) throws ApiException
Build call for getWSDLInfoOfAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getWSDLInfoOfAPI
public WSDLInfoDTO getWSDLInfoOfAPI(String apiId) throws ApiException
Get WSDL Meta Information This operation can be used to retrieve the WSDL meta information of an API. It states whether the API is a SOAP API. If the API is a SOAP API, it states whether it has a single WSDL or a WSDL archive.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- WSDLInfoDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getWSDLInfoOfAPIWithHttpInfo
public ApiResponse<WSDLInfoDTO> getWSDLInfoOfAPIWithHttpInfo(String apiId) throws ApiException
Get WSDL Meta Information This operation can be used to retrieve the WSDL meta information of an API. It states whether the API is a SOAP API. If the API is a SOAP API, it states whether it has a single WSDL or a WSDL archive.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- ApiResponse<WSDLInfoDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getWSDLInfoOfAPIAsync
public okhttp3.Call getWSDLInfoOfAPIAsync(String apiId, ApiCallback<WSDLInfoDTO> _callback) throws ApiException
Get WSDL Meta Information (asynchronously) This operation can be used to retrieve the WSDL meta information of an API. It states whether the API is a SOAP API. If the API is a SOAP API, it states whether it has a single WSDL or a WSDL archive.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (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
-
getWSDLOfAPICall
public okhttp3.Call getWSDLOfAPICall(String apiId, String ifNoneMatch, ApiCallback _callback) throws ApiException
Build call for getWSDLOfAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getWSDLOfAPI
public void getWSDLOfAPI(String apiId, String ifNoneMatch) throws ApiException
Get WSDL definition This operation can be used to retrieve the WSDL definition of an API. It can be either a single WSDL file or a WSDL archive. The type of the WSDL of the API is indicated at the \"wsdlInfo\" element of the API payload definition.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getWSDLOfAPIWithHttpInfo
public ApiResponse<Void> getWSDLOfAPIWithHttpInfo(String apiId, String ifNoneMatch) throws ApiException
Get WSDL definition This operation can be used to retrieve the WSDL definition of an API. It can be either a single WSDL file or a WSDL archive. The type of the WSDL of the API is indicated at the \"wsdlInfo\" element of the API payload definition.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getWSDLOfAPIAsync
public okhttp3.Call getWSDLOfAPIAsync(String apiId, String ifNoneMatch, ApiCallback<Void> _callback) throws ApiException
Get WSDL definition (asynchronously) This operation can be used to retrieve the WSDL definition of an API. It can be either a single WSDL file or a WSDL archive. The type of the WSDL of the API is indicated at the \"wsdlInfo\" element of the API payload definition.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)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
-
importAsyncAPISpecificationCall
public okhttp3.Call importAsyncAPISpecificationCall(File file, String url, String additionalProperties, ApiCallback _callback) throws ApiException
Build call for importAsyncAPISpecification- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
importAsyncAPISpecification
public APIDTO importAsyncAPISpecification(File file, String url, String additionalProperties) throws ApiException
import an AsyncAPI Specification This operation can be used to create and API from the AsyncAPI Specification. Provide either 'url' or 'file' to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importAsyncAPISpecificationWithHttpInfo
public ApiResponse<APIDTO> importAsyncAPISpecificationWithHttpInfo(File file, String url, String additionalProperties) throws ApiException
import an AsyncAPI Specification This operation can be used to create and API from the AsyncAPI Specification. Provide either 'url' or 'file' to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importAsyncAPISpecificationAsync
public okhttp3.Call importAsyncAPISpecificationAsync(File file, String url, String additionalProperties, ApiCallback<APIDTO> _callback) throws ApiException
import an AsyncAPI Specification (asynchronously) This operation can be used to create and API from the AsyncAPI Specification. Provide either 'url' or 'file' to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (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
-
importGraphQLSchemaCall
public okhttp3.Call importGraphQLSchemaCall(String ifMatch, String type, File file, String additionalProperties, ApiCallback _callback) throws ApiException
Build call for importGraphQLSchema- Parameters:
ifMatch- Validator for conditional requests; based on ETag. (optional)type- Definition type to upload (optional)file- Definition to uploads a file (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
importGraphQLSchema
public APIDTO importGraphQLSchema(String ifMatch, String type, File file, String additionalProperties) throws ApiException
Import a GraphQL SDL This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL Schema- Parameters:
ifMatch- Validator for conditional requests; based on ETag. (optional)type- Definition type to upload (optional)file- Definition to uploads a file (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importGraphQLSchemaWithHttpInfo
public ApiResponse<APIDTO> importGraphQLSchemaWithHttpInfo(String ifMatch, String type, File file, String additionalProperties) throws ApiException
Import a GraphQL SDL This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL Schema- Parameters:
ifMatch- Validator for conditional requests; based on ETag. (optional)type- Definition type to upload (optional)file- Definition to uploads a file (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importGraphQLSchemaAsync
public okhttp3.Call importGraphQLSchemaAsync(String ifMatch, String type, File file, String additionalProperties, ApiCallback<APIDTO> _callback) throws ApiException
Import a GraphQL SDL (asynchronously) This operation can be used to create api from api definition.APIMgtDAOTest API definition is GraphQL Schema- Parameters:
ifMatch- Validator for conditional requests; based on ETag. (optional)type- Definition type to upload (optional)file- Definition to uploads a file (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (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
-
importOpenAPIDefinitionCall
public okhttp3.Call importOpenAPIDefinitionCall(File file, String url, String additionalProperties, String inlineAPIDefinition, ApiCallback _callback) throws ApiException
Build call for importOpenAPIDefinition- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)inlineAPIDefinition- Inline content of the OpenAPI definition (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
importOpenAPIDefinition
public APIDTO importOpenAPIDefinition(File file, String url, String additionalProperties, String inlineAPIDefinition) throws ApiException
Import an OpenAPI Definition This operation can be used to create an API from an OpenAPI definition. Provide either `url` or `file` to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)inlineAPIDefinition- Inline content of the OpenAPI definition (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importOpenAPIDefinitionWithHttpInfo
public ApiResponse<APIDTO> importOpenAPIDefinitionWithHttpInfo(File file, String url, String additionalProperties, String inlineAPIDefinition) throws ApiException
Import an OpenAPI Definition This operation can be used to create an API from an OpenAPI definition. Provide either `url` or `file` to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)inlineAPIDefinition- Inline content of the OpenAPI definition (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importOpenAPIDefinitionAsync
public okhttp3.Call importOpenAPIDefinitionAsync(File file, String url, String additionalProperties, String inlineAPIDefinition, ApiCallback<APIDTO> _callback) throws ApiException
Import an OpenAPI Definition (asynchronously) This operation can be used to create an API from an OpenAPI definition. Provide either `url` or `file` to specify the definition. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- Definition to upload as a file (optional)url- Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)inlineAPIDefinition- Inline content of the OpenAPI definition (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
-
importServiceFromCatalogCall
public okhttp3.Call importServiceFromCatalogCall(String serviceKey, APIDTO APIDTO, ApiCallback _callback) throws ApiException
Build call for importServiceFromCatalog- Parameters:
serviceKey- ID of service that should be imported from Service Catalog (required)APIDTO- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
importServiceFromCatalog
public APIDTO importServiceFromCatalog(String serviceKey, APIDTO APIDTO) throws ApiException
Import a Service from Service Catalog This operation can be used to create an API from a Service from Service Catalog- Parameters:
serviceKey- ID of service that should be imported from Service Catalog (required)APIDTO- (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importServiceFromCatalogWithHttpInfo
public ApiResponse<APIDTO> importServiceFromCatalogWithHttpInfo(String serviceKey, APIDTO APIDTO) throws ApiException
Import a Service from Service Catalog This operation can be used to create an API from a Service from Service Catalog- Parameters:
serviceKey- ID of service that should be imported from Service Catalog (required)APIDTO- (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importServiceFromCatalogAsync
public okhttp3.Call importServiceFromCatalogAsync(String serviceKey, APIDTO APIDTO, ApiCallback<APIDTO> _callback) throws ApiException
Import a Service from Service Catalog (asynchronously) This operation can be used to create an API from a Service from Service Catalog- Parameters:
serviceKey- ID of service that should be imported from Service Catalog (required)APIDTO- (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
-
importWSDLDefinitionCall
public okhttp3.Call importWSDLDefinitionCall(File file, String url, String additionalProperties, String implementationType, ApiCallback _callback) throws ApiException
Build call for importWSDLDefinition- Parameters:
file- WSDL definition as a file or archive **Sample cURL to Upload WSDL File** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=@api.wsdl -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" **Sample cURL to Upload WSDL Archive** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=\\\"@wsdl.zip;type=application/zip\\\" -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" (optional)url- WSDL Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)implementationType- If 'SOAP' is specified, the API will be created with only one resource 'POST /_*' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
importWSDLDefinition
public APIDTO importWSDLDefinition(File file, String url, String additionalProperties, String implementationType) throws ApiException
Import a WSDL Definition This operation can be used to create an API using a WSDL definition. Provide either `url` or `file` to specify the definition. WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- WSDL definition as a file or archive **Sample cURL to Upload WSDL File** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=@api.wsdl -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" **Sample cURL to Upload WSDL Archive** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=\\\"@wsdl.zip;type=application/zip\\\" -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" (optional)url- WSDL Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)implementationType- If 'SOAP' is specified, the API will be created with only one resource 'POST /_*' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importWSDLDefinitionWithHttpInfo
public ApiResponse<APIDTO> importWSDLDefinitionWithHttpInfo(File file, String url, String additionalProperties, String implementationType) throws ApiException
Import a WSDL Definition This operation can be used to create an API using a WSDL definition. Provide either `url` or `file` to specify the definition. WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- WSDL definition as a file or archive **Sample cURL to Upload WSDL File** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=@api.wsdl -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" **Sample cURL to Upload WSDL Archive** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=\\\"@wsdl.zip;type=application/zip\\\" -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" (optional)url- WSDL Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)implementationType- If 'SOAP' is specified, the API will be created with only one resource 'POST /_*' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
importWSDLDefinitionAsync
public okhttp3.Call importWSDLDefinitionAsync(File file, String url, String additionalProperties, String implementationType, ApiCallback<APIDTO> _callback) throws ApiException
Import a WSDL Definition (asynchronously) This operation can be used to create an API using a WSDL definition. Provide either `url` or `file` to specify the definition. WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. Specify additionalProperties with **at least** API's name, version, context and endpointConfig.- Parameters:
file- WSDL definition as a file or archive **Sample cURL to Upload WSDL File** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=@api.wsdl -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" **Sample cURL to Upload WSDL Archive** curl -k -H \\\"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\\\" -F file=\\\"@wsdl.zip;type=application/zip\\\" -F additionalProperties=@data.json \\\"https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl\\\" (optional)url- WSDL Definition url (optional)additionalProperties- Additional attributes specified as a stringified JSON with API's schema (optional)implementationType- If 'SOAP' is specified, the API will be created with only one resource 'POST /_*' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)_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
-
reimportServiceFromCatalogCall
public okhttp3.Call reimportServiceFromCatalogCall(String apiId, ApiCallback _callback) throws ApiException
Build call for reimportServiceFromCatalog- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
reimportServiceFromCatalog
public APIDTO reimportServiceFromCatalog(String apiId) throws ApiException
Update the Service that is used to create the API This operation can be used to re-import the Service used to create the API- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
reimportServiceFromCatalogWithHttpInfo
public ApiResponse<APIDTO> reimportServiceFromCatalogWithHttpInfo(String apiId) throws ApiException
Update the Service that is used to create the API This operation can be used to re-import the Service used to create the API- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
reimportServiceFromCatalogAsync
public okhttp3.Call reimportServiceFromCatalogAsync(String apiId, ApiCallback<APIDTO> _callback) throws ApiException
Update the Service that is used to create the API (asynchronously) This operation can be used to re-import the Service used to create the API- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (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
-
updateAPICall
public okhttp3.Call updateAPICall(String apiId, APIDTO APIDTO, String ifMatch, ApiCallback _callback) throws ApiException
Build call for updateAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)APIDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateAPI
public APIDTO updateAPI(String apiId, APIDTO APIDTO, String ifMatch) throws ApiException
Update an API This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)APIDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIWithHttpInfo
public ApiResponse<APIDTO> updateAPIWithHttpInfo(String apiId, APIDTO APIDTO, String ifMatch) throws ApiException
Update an API This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)APIDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIAsync
public okhttp3.Call updateAPIAsync(String apiId, APIDTO APIDTO, String ifMatch, ApiCallback<APIDTO> _callback) throws ApiException
Update an API (asynchronously) This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)APIDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
updateAPISwaggerCall
public okhttp3.Call updateAPISwaggerCall(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback _callback) throws ApiException
Build call for updateAPISwagger- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- Swagger definition of the API (optional)url- Swagger definition URL of the API (optional)file- Swagger definitio as a file (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateAPISwagger
public String updateAPISwagger(String apiId, String ifMatch, String apiDefinition, String url, File file) throws ApiException
Update Swagger Definition This operation can be used to update the swagger definition of an existing API. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- Swagger definition of the API (optional)url- Swagger definition URL of the API (optional)file- Swagger definitio as a file (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPISwaggerWithHttpInfo
public ApiResponse<String> updateAPISwaggerWithHttpInfo(String apiId, String ifMatch, String apiDefinition, String url, File file) throws ApiException
Update Swagger Definition This operation can be used to update the swagger definition of an existing API. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- Swagger definition of the API (optional)url- Swagger definition URL of the API (optional)file- Swagger definitio as a file (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPISwaggerAsync
public okhttp3.Call updateAPISwaggerAsync(String apiId, String ifMatch, String apiDefinition, String url, File file, ApiCallback<String> _callback) throws ApiException
Update Swagger Definition (asynchronously) This operation can be used to update the swagger definition of an existing API. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)apiDefinition- Swagger definition of the API (optional)url- Swagger definition URL of the API (optional)file- Swagger definitio as a file (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
-
updateAPIThumbnailCall
public okhttp3.Call updateAPIThumbnailCall(String apiId, File file, String ifMatch, ApiCallback _callback) throws ApiException
Build call for updateAPIThumbnail- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateAPIThumbnail
public FileInfoDTO updateAPIThumbnail(String apiId, File file, String ifMatch) throws ApiException
Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- FileInfoDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIThumbnailWithHttpInfo
public ApiResponse<FileInfoDTO> updateAPIThumbnailWithHttpInfo(String apiId, File file, String ifMatch) throws ApiException
Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<FileInfoDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIThumbnailAsync
public okhttp3.Call updateAPIThumbnailAsync(String apiId, File file, String ifMatch, ApiCallback<FileInfoDTO> _callback) throws ApiException
Upload a Thumbnail Image (asynchronously) This operation can be used to upload a thumbnail image of an API. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
updateTopicsCall
public okhttp3.Call updateTopicsCall(String apiId, TopicListDTO topicListDTO, String ifMatch, ApiCallback _callback) throws ApiException
Build call for updateTopics- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)topicListDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateTopics
public APIDTO updateTopics(String apiId, TopicListDTO topicListDTO, String ifMatch) throws ApiException
Update Topics This operation can be used to update topics of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)topicListDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- APIDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateTopicsWithHttpInfo
public ApiResponse<APIDTO> updateTopicsWithHttpInfo(String apiId, TopicListDTO topicListDTO, String ifMatch) throws ApiException
Update Topics This operation can be used to update topics of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)topicListDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<APIDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateTopicsAsync
public okhttp3.Call updateTopicsAsync(String apiId, TopicListDTO topicListDTO, String ifMatch, ApiCallback<APIDTO> _callback) throws ApiException
Update Topics (asynchronously) This operation can be used to update topics of an existing API.- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)topicListDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
updateWSDLOfAPICall
public okhttp3.Call updateWSDLOfAPICall(String apiId, String ifMatch, File file, String url, ApiCallback _callback) throws ApiException
Build call for updateWSDLOfAPI- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- WSDL file or archive to upload (optional)url- WSDL Definition url (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateWSDLOfAPI
public void updateWSDLOfAPI(String apiId, String ifMatch, File file, String url) throws ApiException
Update WSDL Definition This operation can be used to update the WSDL definition of an existing API. WSDL to be updated can be passed as either \"url\" or \"file\". Only one of \"url\" or \"file\" can be used at the same time. \"file\" can be specified as a single WSDL file or as a zip file which has a WSDL and its dependencies (eg: XSDs)- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- WSDL file or archive to upload (optional)url- WSDL Definition url (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateWSDLOfAPIWithHttpInfo
public ApiResponse<Void> updateWSDLOfAPIWithHttpInfo(String apiId, String ifMatch, File file, String url) throws ApiException
Update WSDL Definition This operation can be used to update the WSDL definition of an existing API. WSDL to be updated can be passed as either \"url\" or \"file\". Only one of \"url\" or \"file\" can be used at the same time. \"file\" can be specified as a single WSDL file or as a zip file which has a WSDL and its dependencies (eg: XSDs)- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- WSDL file or archive to upload (optional)url- WSDL Definition url (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateWSDLOfAPIAsync
public okhttp3.Call updateWSDLOfAPIAsync(String apiId, String ifMatch, File file, String url, ApiCallback<Void> _callback) throws ApiException
Update WSDL Definition (asynchronously) This operation can be used to update the WSDL definition of an existing API. WSDL to be updated can be passed as either \"url\" or \"file\". Only one of \"url\" or \"file\" can be used at the same time. \"file\" can be specified as a single WSDL file or as a zip file which has a WSDL and its dependencies (eg: XSDs)- Parameters:
apiId- **API ID** consisting of the **UUID** of the API. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- WSDL file or archive to upload (optional)url- WSDL Definition url (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
-
-