| Package | Description |
|---|---|
| org.wso2.am.integration.clients.store.api | |
| org.wso2.am.integration.clients.store.api.v1 |
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<AlertConfigDTO> |
AlertConfigurationApi.addAlertConfigWithHttpInfo(String alertType,
String configurationId,
Map<String,String> requestBody)
Add AbnormalRequestsPerMin Alert Configurations.
|
ApiResponse<CommentDTO> |
CommentsApi.addCommentToAPIWithHttpInfo(String apiId,
PostRequestBodyDTO postRequestBodyDTO,
String replyTo)
Add an API Comment
|
ApiResponse<APICategoryListDTO> |
ApiCategoryCollectionApi.apiCategoriesGetWithHttpInfo(String xWSO2Tenant)
Get All API Categories
Get all API categories
|
ApiResponse<Void> |
ApiDocumentsApi.apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId,
String documentId,
String xWSO2Tenant,
String ifNoneMatch)
Get the Content of an API Document
This operation can be used to retrive the content of an API's document.
|
ApiResponse<DocumentDTO> |
ApiDocumentsApi.apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId,
String documentId,
String xWSO2Tenant,
String ifNoneMatch)
Get a Document of an API
This operation can be used to retrieve a particular document's metadata associated with an API.
|
ApiResponse<DocumentListDTO> |
ApiDocumentsApi.apisApiIdDocumentsGetWithHttpInfo(String apiId,
Integer limit,
Integer offset,
String xWSO2Tenant,
String ifNoneMatch)
Get a List of Documents of an API
This operation can be used to retrive a list of documents belonging to an API by providing the id of the API.
|
ApiResponse<APIDTO> |
ApIsApi.apisApiIdGetWithHttpInfo(String apiId,
String xWSO2Tenant,
String ifNoneMatch)
Get Details of an API
Using this operation, you can retrieve complete details of a single API.
|
ApiResponse<GraphQLQueryComplexityInfoDTO> |
GraphQlPoliciesApi.apisApiIdGraphqlPoliciesComplexityGetWithHttpInfo(String apiId)
Get the Complexity Related Details of an API
This operation can be used to retrieve complexity related details belonging to an API by providing the API id.
|
ApiResponse<GraphQLSchemaTypeListDTO> |
GraphQlPoliciesApi.apisApiIdGraphqlPoliciesComplexityTypesGetWithHttpInfo(String apiId)
Retrieve Types and Fields of a GraphQL Schema
This operation can be used to retrieve all types and fields of the GraphQL Schema by providing the API id.
|
ApiResponse<Void> |
ApIsApi.apisApiIdGraphqlSchemaGetWithHttpInfo(String apiId,
String ifNoneMatch,
String xWSO2Tenant)
Get GraphQL Definition
You can use this operation to retrieve the swagger definition of an API.
|
ApiResponse<RatingListDTO> |
RatingsApi.apisApiIdRatingsGetWithHttpInfo(String apiId,
Integer limit,
Integer offset,
String xWSO2Tenant)
Retrieve API Ratings
This operation can be used to retrieve the list of ratings of an API.
|
ApiResponse<byte[]> |
SdKsApi.apisApiIdSdksLanguageGetWithHttpInfo(String apiId,
String language,
String xWSO2Tenant)
Generate a SDK for an API
This operation can be used to generate SDKs (System Development Kits), for the APIs available in the API Developer Portal, for a requested development language.
|
ApiResponse<ThrottlingPolicyDTO> |
ApIsApi.apisApiIdSubscriptionPoliciesGetWithHttpInfo(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.
|
ApiResponse<String> |
ApIsApi.apisApiIdSwaggerGetWithHttpInfo(String apiId,
String labelName,
String environmentName,
String clusterName,
String ifNoneMatch,
String xWSO2Tenant)
Get Swagger Definition
You can use this operation to retrieve the swagger definition of an API.
|
ApiResponse<Void> |
ApIsApi.apisApiIdThumbnailGetWithHttpInfo(String apiId,
String xWSO2Tenant,
String ifNoneMatch)
Get Thumbnail Image
This operation can be used to download a thumbnail image of an API.
|
ApiResponse<Void> |
RatingsApi.apisApiIdUserRatingDeleteWithHttpInfo(String apiId,
String xWSO2Tenant,
String ifMatch)
Delete User API Rating
This operation can be used to delete logged in user API rating.
|
ApiResponse<RatingDTO> |
RatingsApi.apisApiIdUserRatingGetWithHttpInfo(String apiId,
String xWSO2Tenant,
String ifNoneMatch)
Retrieve API Rating of User
This operation can be used to get the user rating of an API.
|
ApiResponse<RatingDTO> |
RatingsApi.apisApiIdUserRatingPutWithHttpInfo(String apiId,
RatingDTO ratingDTO,
String xWSO2Tenant)
Add or Update Logged in User's Rating for an API
This operation can be used to add or update an API rating.
|
ApiResponse<APIListDTO> |
ApIsApi.apisGetWithHttpInfo(Integer limit,
Integer offset,
String xWSO2Tenant,
String query,
String ifNoneMatch)
Retrieve/Search APIs
This operation provides you a list of available APIs qualifying under a given search condition.
|
ApiResponse<APIKeyDTO> |
ApiKeysApi.applicationsApplicationIdApiKeysKeyTypeGeneratePostWithHttpInfo(String applicationId,
String keyType,
String ifMatch,
APIKeyGenerateRequestDTO apIKeyGenerateRequestDTO)
Generate API Key
Generate a self contained API Key for the application
|
ApiResponse<Void> |
ApiKeysApi.applicationsApplicationIdApiKeysKeyTypeRevokePostWithHttpInfo(String applicationId,
String keyType,
String ifMatch,
APIKeyRevokeRequestDTO apIKeyRevokeRequestDTO)
Revoke API Key
Revoke a self contained API Key for the application
|
ApiResponse<Void> |
ApplicationsApi.applicationsApplicationIdDeleteWithHttpInfo(String applicationId,
String ifMatch)
Remove an Application
This operation can be used to remove an application specifying its id.
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdGenerateKeysPostWithHttpInfo(String applicationId,
ApplicationKeyGenerateRequestDTO applicationKeyGenerateRequestDTO)
Generate Application Keys
Generate keys (Consumer key/secret) for application
|
ApiResponse<ApplicationDTO> |
ApplicationsApi.applicationsApplicationIdGetWithHttpInfo(String applicationId,
String ifNoneMatch)
Get Details of an Application
This operation can be used to retrieve details of an individual application specifying the application id in the URI.
|
ApiResponse<ApplicationKeyListDTO> |
ApplicationKeysApi.applicationsApplicationIdKeysGetWithHttpInfo(String applicationId)
Deprecated.
|
ApiResponse<Void> |
ApplicationKeysApi.applicationsApplicationIdKeysKeyTypeCleanUpPostWithHttpInfo(String applicationId,
String keyType,
String ifMatch)
Deprecated.
|
ApiResponse<ApplicationTokenDTO> |
ApplicationTokensApi.applicationsApplicationIdKeysKeyTypeGenerateTokenPostWithHttpInfo(String applicationId,
String keyType,
ApplicationTokenGenerateRequestDTO applicationTokenGenerateRequestDTO,
String ifMatch)
Deprecated.
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdKeysKeyTypeGetWithHttpInfo(String applicationId,
String keyType,
String groupId)
Deprecated.
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdKeysKeyTypePutWithHttpInfo(String applicationId,
String keyType,
ApplicationKeyDTO applicationKeyDTO)
Deprecated.
|
ApiResponse<ApplicationKeyReGenerateResponseDTO> |
ApplicationKeysApi.applicationsApplicationIdKeysKeyTypeRegenerateSecretPostWithHttpInfo(String applicationId,
String keyType)
Deprecated.
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdMapKeysPostWithHttpInfo(String applicationId,
ApplicationKeyMappingRequestDTO applicationKeyMappingRequestDTO)
Map Application Keys
Map keys (Consumer key/secret) to an application
|
ApiResponse<ApplicationKeyListDTO> |
ApplicationKeysApi.applicationsApplicationIdOauthKeysGetWithHttpInfo(String applicationId)
Retrieve All Application Keys
Retrieve keys (Consumer key/secret) of application
|
ApiResponse<Void> |
ApplicationKeysApi.applicationsApplicationIdOauthKeysKeyMappingIdCleanUpPostWithHttpInfo(String applicationId,
String keyMappingId,
String ifMatch)
Clean-Up Application Keys
Clean up keys after failed key generation of an application
|
ApiResponse<ApplicationTokenDTO> |
ApplicationTokensApi.applicationsApplicationIdOauthKeysKeyMappingIdGenerateTokenPostWithHttpInfo(String applicationId,
String keyMappingId,
ApplicationTokenGenerateRequestDTO applicationTokenGenerateRequestDTO,
String ifMatch)
Generate Application Token
Generate an access token for application by client_credentials grant type
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdOauthKeysKeyMappingIdGetWithHttpInfo(String applicationId,
String keyMappingId,
String groupId)
Get Key Details of a Given Type
This operation can be used to retrieve key details of an individual application specifying the key type in the URI.
|
ApiResponse<ApplicationKeyDTO> |
ApplicationKeysApi.applicationsApplicationIdOauthKeysKeyMappingIdPutWithHttpInfo(String applicationId,
String keyMappingId,
ApplicationKeyDTO applicationKeyDTO)
Update Grant Types and Callback URL of an Application
This operation can be used to update grant types and callback url of an application.
|
ApiResponse<ApplicationKeyReGenerateResponseDTO> |
ApplicationKeysApi.applicationsApplicationIdOauthKeysKeyMappingIdRegenerateSecretPostWithHttpInfo(String applicationId,
String keyMappingId)
Re-Generate Consumer Secret
This operation can be used to re generate consumer secret for an application for the give key type
|
ApiResponse<ApplicationDTO> |
ApplicationsApi.applicationsApplicationIdPutWithHttpInfo(String applicationId,
ApplicationDTO applicationDTO,
String ifMatch)
Update an Application
This operation can be used to update an application.
|
ApiResponse<File> |
ImportExportApi.applicationsExportGetWithHttpInfo(String appName,
String appOwner,
Boolean withKeys,
String format)
Export an Application
This operation can be used to export the details of a particular application as a zip file.
|
ApiResponse<ApplicationListDTO> |
ApplicationsApi.applicationsGetWithHttpInfo(String groupId,
String query,
String sortBy,
String sortOrder,
Integer limit,
Integer offset,
String ifNoneMatch)
Retrieve/Search Applications
This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
|
ApiResponse<ApplicationInfoDTO> |
ApplicationIndividualApi.applicationsImportPostWithHttpInfo(File file,
Boolean preserveOwner,
Boolean skipSubscriptions,
String appOwner,
Boolean skipApplicationKeys,
Boolean update)
Import an Application
This operation can be used to import an application.
|
ApiResponse<ApplicationDTO> |
ApplicationsApi.applicationsPostWithHttpInfo(ApplicationDTO applicationDTO)
Create a New Application
This operation can be used to create a new application specifying the details of the application in the payload.
|
ApiResponse<Void> |
UsersApi.changeUserPasswordWithHttpInfo(CurrentAndNewPasswordsDTO currentAndNewPasswordsDTO)
Change the Password of the user
Using this operation, logged-in user can change their password.
|
ApiResponse<Void> |
AlertConfigurationApi.deleteAlertConfigWithHttpInfo(String alertType,
String configurationId)
Delete the Selected Configuration from AbnormalRequestsPerMin Alert Type.
|
ApiResponse<Void> |
CommentsApi.deleteCommentWithHttpInfo(String commentId,
String apiId,
String ifMatch)
Delete an API Comment
Remove a Comment
|
ApiResponse<CommentDTO> |
CommentsApi.editCommentOfAPIWithHttpInfo(String commentId,
String apiId,
PatchRequestBodyDTO patchRequestBodyDTO)
Edit a comment
Edit the individual comment
|
ApiResponse<AlertConfigListDTO> |
AlertConfigurationApi.getAllAlertConfigsWithHttpInfo(String alertType)
Get All AbnormalRequestsPerMin Alert Configurations
This operation is used to get all configurations of the AbnormalRequestsPerMin alert type.
|
ApiResponse<CommentListDTO> |
CommentsApi.getAllCommentsOfAPIWithHttpInfo(String apiId,
String xWSO2Tenant,
Integer limit,
Integer offset,
Boolean includeCommenterInfo)
Retrieve API Comments
Get a list of Comments that are already added to APIs
|
ApiResponse<TopicListDTO> |
TopicsApi.getAllTopicsOfAPIWithHttpInfo(String apiId,
String xWSO2Tenant)
Get a list of available topics for a given async API
This operation will provide a list of topics available for a given Async API, based on the provided API ID.
|
ApiResponse<WebhookSubscriptionListDTO> |
WebhooksApi.getAllWebhooksOfAPIWithHttpInfo(String applicationId,
String apiId,
String xWSO2Tenant)
Get available web hook subscriptions for a given application.
|
ApiResponse<CommentDTO> |
CommentsApi.getCommentOfAPIWithHttpInfo(String commentId,
String apiId,
String xWSO2Tenant,
String ifNoneMatch,
Boolean includeCommenterInfo,
Integer replyLimit,
Integer replyOffset)
Get Details of an API Comment
Get the individual comment given by a username for a certain API.
|
ApiResponse<AlertTypesListDTO> |
AlertsApi.getDevportalAlertTypesWithHttpInfo()
Get the List of API Developer Portal Alert Types.
|
ApiResponse<CommentListDTO> |
CommentsApi.getRepliesOfCommentWithHttpInfo(String commentId,
String apiId,
String xWSO2Tenant,
Integer limit,
Integer offset,
String ifNoneMatch,
Boolean includeCommenterInfo)
Get replies of a comment
Get replies of a comment
|
ApiResponse<AlertsInfoDTO> |
AlertSubscriptionsApi.getSubscribedAlertTypesWithHttpInfo()
Get the List of API Developer Portal Alert Types Subscribed by the User.
|
ApiResponse<Void> |
ApIsApi.getWSDLOfAPIWithHttpInfo(String apiId,
String labelName,
String environmentName,
String ifNoneMatch,
String xWSO2Tenant)
Get API WSDL definition
This operation can be used to retrieve the swagger definition of an API.
|
ApiResponse<KeyManagerListDTO> |
KeyManagersCollectionApi.keyManagersGetWithHttpInfo(String xWSO2Tenant)
Get All Key Managers
Get all Key managers
|
ApiResponse<RecommendationsDTO> |
RecommendationsApi.recommendationsGetWithHttpInfo()
Give API Recommendations for a User
This API can be used to get recommended APIs for a user who logs into the API Developer Portal
|
ApiResponse<Void> |
SdKsApi.sdkGenLanguagesGetWithHttpInfo()
Get a List of Supported SDK Languages
This operation will provide a list of programming languages that are supported by the swagger codegen library for generating System Development Kits (SDKs) for APIs available in the API Manager Developer Portal
|
ApiResponse<SearchResultListDTO> |
UnifiedSearchApi.searchGetWithHttpInfo(Integer limit,
Integer offset,
String xWSO2Tenant,
String query,
String ifNoneMatch)
Retrieve/Search APIs and API Documents by Content
This operation provides you a list of available APIs and API Documents qualifying the given keyword match.
|
ApiResponse<ApplicationAttributeListDTO> |
SettingsApi.settingsApplicationAttributesGetWithHttpInfo(String ifNoneMatch)
Get All Application Attributes from Configuration
This operation can be used to retrieve the application attributes from configuration.
|
ApiResponse<SettingsDTO> |
SettingsApi.settingsGetWithHttpInfo(String xWSO2Tenant)
Retreive Devportal settings
Retreive Devportal Settings
|
ApiResponse<AlertsInfoResponseDTO> |
AlertSubscriptionsApi.subscribeToAlertsWithHttpInfo(AlertsInfoDTO alertsInfoDTO)
Subscribe to the Selected Alert Types by the User.
|
ApiResponse<SubscriptionListDTO> |
SubscriptionsApi.subscriptionsGetWithHttpInfo(String apiId,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch)
Get All Subscriptions
This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token.
|
ApiResponse<List<SubscriptionDTO>> |
SubscriptionsApi.subscriptionsMultiplePostWithHttpInfo(List<SubscriptionDTO> subscriptionDTO,
String xWSO2Tenant)
Add New Subscriptions
This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
|
ApiResponse<SubscriptionDTO> |
SubscriptionsApi.subscriptionsPostWithHttpInfo(SubscriptionDTO subscriptionDTO,
String xWSO2Tenant)
Add a New Subscription
This operation can be used to add a new subscription providing the id of the API and the application.
|
ApiResponse<Void> |
SubscriptionsApi.subscriptionsSubscriptionIdDeleteWithHttpInfo(String subscriptionId,
String ifMatch)
Remove a Subscription
This operation can be used to remove a subscription.
|
ApiResponse<SubscriptionDTO> |
SubscriptionsApi.subscriptionsSubscriptionIdGetWithHttpInfo(String subscriptionId,
String ifNoneMatch)
Get Details of a Subscription
This operation can be used to get details of a single subscription.
|
ApiResponse<SubscriptionDTO> |
SubscriptionsApi.subscriptionsSubscriptionIdPutWithHttpInfo(String subscriptionId,
SubscriptionDTO subscriptionDTO,
String xWSO2Tenant)
Update Existing Subscription
This operation can be used to update a subscription providing the subscription id, api id, application Id, status and updated throttling policy tier.
|
ApiResponse<APIMonetizationUsageDTO> |
ApiMonetizationApi.subscriptionsSubscriptionIdUsageGetWithHttpInfo(String subscriptionId)
Get Details of a Pending Invoice for a Monetized Subscription with Metered Billing.
|
ApiResponse<TagListDTO> |
TagsApi.tagsGetWithHttpInfo(Integer limit,
Integer offset,
String xWSO2Tenant,
String ifNoneMatch)
Get All Tags
This operation can be used to retrieve a list of tags that are already added to APIs.
|
ApiResponse<TenantListDTO> |
TenantsApi.tenantsGetWithHttpInfo(String state,
Integer limit,
Integer offset)
Get Tenants by State
This operation is to get tenants by state
|
ApiResponse<List<ThrottlingPolicyListDTO>> |
ThrottlingPoliciesApi.throttlingPoliciesPolicyLevelGetWithHttpInfo(String policyLevel,
Integer limit,
Integer offset,
String ifNoneMatch,
String xWSO2Tenant)
Get All Available Throttling Policies
Get available Throttling Policies
|
ApiResponse<ThrottlingPolicyDTO> |
ThrottlingPoliciesApi.throttlingPoliciesPolicyLevelPolicyIdGetWithHttpInfo(String policyId,
String policyLevel,
String xWSO2Tenant,
String ifNoneMatch)
Get Details of a Throttling Policy
This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name.
|
ApiResponse<Void> |
AlertSubscriptionsApi.unsubscribeAllAlertsWithHttpInfo()
Unsubscribe User from All the Alert Types.
|
Copyright © 2021 WSO2 Inc. All rights reserved.