Class ApplicationsApi


  • public class ApplicationsApi
    extends Object
    • Constructor Detail

      • ApplicationsApi

        public ApplicationsApi()
      • ApplicationsApi

        public ApplicationsApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • applicationsApplicationIdDeleteCall

        public okhttp3.Call applicationsApplicationIdDeleteCall​(String applicationId,
                                                                String ifMatch,
                                                                ApiCallback _callback)
                                                         throws ApiException
        Build call for applicationsApplicationIdDelete
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (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
      • applicationsApplicationIdDelete

        public void applicationsApplicationIdDelete​(String applicationId,
                                                    String ifMatch)
                                             throws ApiException
        Remove an Application This operation can be used to remove an application specifying its id.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (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
      • applicationsApplicationIdDeleteWithHttpInfo

        public ApiResponse<Void> applicationsApplicationIdDeleteWithHttpInfo​(String applicationId,
                                                                             String ifMatch)
                                                                      throws ApiException
        Remove an Application This operation can be used to remove an application specifying its id.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (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
      • applicationsApplicationIdDeleteAsync

        public okhttp3.Call applicationsApplicationIdDeleteAsync​(String applicationId,
                                                                 String ifMatch,
                                                                 ApiCallback<Void> _callback)
                                                          throws ApiException
        Remove an Application (asynchronously) This operation can be used to remove an application specifying its id.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (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
      • applicationsApplicationIdGetCall

        public okhttp3.Call applicationsApplicationIdGetCall​(String applicationId,
                                                             String ifNoneMatch,
                                                             String xWSO2Tenant,
                                                             ApiCallback _callback)
                                                      throws ApiException
        Build call for applicationsApplicationIdGet
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • applicationsApplicationIdGet

        public ApplicationDTO applicationsApplicationIdGet​(String applicationId,
                                                           String ifNoneMatch,
                                                           String xWSO2Tenant)
                                                    throws ApiException
        Get Details of an Application This operation can be used to retrieve details of an individual application specifying the application id in the URI.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        ApplicationDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsApplicationIdGetWithHttpInfo

        public ApiResponse<ApplicationDTO> applicationsApplicationIdGetWithHttpInfo​(String applicationId,
                                                                                    String ifNoneMatch,
                                                                                    String xWSO2Tenant)
                                                                             throws ApiException
        Get Details of an Application This operation can be used to retrieve details of an individual application specifying the application id in the URI.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        ApiResponse<ApplicationDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsApplicationIdGetAsync

        public okhttp3.Call applicationsApplicationIdGetAsync​(String applicationId,
                                                              String ifNoneMatch,
                                                              String xWSO2Tenant,
                                                              ApiCallback<ApplicationDTO> _callback)
                                                       throws ApiException
        Get Details of an Application (asynchronously) This operation can be used to retrieve details of an individual application specifying the application id in the URI.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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
      • applicationsApplicationIdPutCall

        public okhttp3.Call applicationsApplicationIdPutCall​(String applicationId,
                                                             ApplicationDTO applicationDTO,
                                                             String ifMatch,
                                                             ApiCallback _callback)
                                                      throws ApiException
        Build call for applicationsApplicationIdPut
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        applicationDTO - Application object that needs to be updated (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
      • applicationsApplicationIdPut

        public ApplicationDTO applicationsApplicationIdPut​(String applicationId,
                                                           ApplicationDTO applicationDTO,
                                                           String ifMatch)
                                                    throws ApiException
        Update an Application This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        applicationDTO - Application object that needs to be updated (required)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        Returns:
        ApplicationDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsApplicationIdPutWithHttpInfo

        public ApiResponse<ApplicationDTO> applicationsApplicationIdPutWithHttpInfo​(String applicationId,
                                                                                    ApplicationDTO applicationDTO,
                                                                                    String ifMatch)
                                                                             throws ApiException
        Update an Application This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        applicationDTO - Application object that needs to be updated (required)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        Returns:
        ApiResponse<ApplicationDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsApplicationIdPutAsync

        public okhttp3.Call applicationsApplicationIdPutAsync​(String applicationId,
                                                              ApplicationDTO applicationDTO,
                                                              String ifMatch,
                                                              ApiCallback<ApplicationDTO> _callback)
                                                       throws ApiException
        Update an Application (asynchronously) This operation can be used to update an application. Upon succesfull you will retrieve the updated application as the response.
        Parameters:
        applicationId - Application Identifier consisting of the UUID of the Application. (required)
        applicationDTO - Application object that needs to be updated (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
      • applicationsGetCall

        public okhttp3.Call applicationsGetCall​(String groupId,
                                                String query,
                                                String sortBy,
                                                String sortOrder,
                                                Integer limit,
                                                Integer offset,
                                                String ifNoneMatch,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for applicationsGet
        Parameters:
        groupId - Application Group Id (optional)
        query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)
        sortBy - (optional)
        sortOrder - (optional)
        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 resourec. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • applicationsGet

        public ApplicationListDTO applicationsGet​(String groupId,
                                                  String query,
                                                  String sortBy,
                                                  String sortOrder,
                                                  Integer limit,
                                                  Integer offset,
                                                  String ifNoneMatch)
                                           throws ApiException
        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.
        Parameters:
        groupId - Application Group Id (optional)
        query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)
        sortBy - (optional)
        sortOrder - (optional)
        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 resourec. (optional)
        Returns:
        ApplicationListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsGetWithHttpInfo

        public ApiResponse<ApplicationListDTO> applicationsGetWithHttpInfo​(String groupId,
                                                                           String query,
                                                                           String sortBy,
                                                                           String sortOrder,
                                                                           Integer limit,
                                                                           Integer offset,
                                                                           String ifNoneMatch)
                                                                    throws ApiException
        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.
        Parameters:
        groupId - Application Group Id (optional)
        query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)
        sortBy - (optional)
        sortOrder - (optional)
        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 resourec. (optional)
        Returns:
        ApiResponse<ApplicationListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsGetAsync

        public okhttp3.Call applicationsGetAsync​(String groupId,
                                                 String query,
                                                 String sortBy,
                                                 String sortOrder,
                                                 Integer limit,
                                                 Integer offset,
                                                 String ifNoneMatch,
                                                 ApiCallback<ApplicationListDTO> _callback)
                                          throws ApiException
        Retrieve/Search Applications (asynchronously) This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
        Parameters:
        groupId - Application Group Id (optional)
        query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)
        sortBy - (optional)
        sortOrder - (optional)
        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 resourec. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
      • applicationsPostCall

        public okhttp3.Call applicationsPostCall​(ApplicationDTO applicationDTO,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for applicationsPost
        Parameters:
        applicationDTO - Application object that is to be created. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • applicationsPost

        public ApplicationDTO applicationsPost​(ApplicationDTO applicationDTO)
                                        throws ApiException
        Create a New Application This operation can be used to create a new application specifying the details of the application in the payload.
        Parameters:
        applicationDTO - Application object that is to be created. (required)
        Returns:
        ApplicationDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsPostWithHttpInfo

        public ApiResponse<ApplicationDTO> applicationsPostWithHttpInfo​(ApplicationDTO applicationDTO)
                                                                 throws ApiException
        Create a New Application This operation can be used to create a new application specifying the details of the application in the payload.
        Parameters:
        applicationDTO - Application object that is to be created. (required)
        Returns:
        ApiResponse<ApplicationDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • applicationsPostAsync

        public okhttp3.Call applicationsPostAsync​(ApplicationDTO applicationDTO,
                                                  ApiCallback<ApplicationDTO> _callback)
                                           throws ApiException
        Create a New Application (asynchronously) This operation can be used to create a new application specifying the details of the application in the payload.
        Parameters:
        applicationDTO - Application object that is to be created. (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