Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
.swagger-codegen
docs
gradle/wrapper
src/main
.gitignore
.swagger-codegen-ignore
README.md
build.gradle
git_push.sh
gradlew
gradlew.bat
pom.xml

README.md

swagger-android-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-android-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-android-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/swagger-android-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.api.ApiDocApi;

public class ApiDocApiExample {

    public static void main(String[] args) {
        ApiDocApi apiInstance = new ApiDocApi();
        String xEmbarcaderoApplicationId = "xEmbarcaderoApplicationId_example"; // String | 
        String xEmbarcaderoAppSecret = "xEmbarcaderoAppSecret_example"; // String | 
        String xEmbarcaderoMasterSecret = "xEmbarcaderoMasterSecret_example"; // String | 
        try {
            apiInstance.aPI(xEmbarcaderoApplicationId, xEmbarcaderoAppSecret, xEmbarcaderoMasterSecret);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiDocApi#aPI");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class Method HTTP request Description
ApiDocApi aPI GET /api Get API EndPoints
ApiDocApi getAPIJSONFormat GET /api/apidoc.json Get JSON
ApiDocApi getAPIYAMLFormat GET /api/apidoc.yaml Get YAML
ApiDocApi getAPIYAMLFormatEndPoint GET /api/{item}/apidoc.yaml Get API EndPoint
EdgeModulesApi getModule GET /edgemodules/{mname} Get Module
EdgeModulesApi getModuleResource GET /edgemodules/{mname}/resources/{name} Get EdgeModule Resource
EdgeModulesApi getModuleResources GET /edgemodules/{mname}/resources Get EdgeModule Resources
EdgeModulesApi getModules GET /edgemodules Get Module
EdgeModulesApi getModulesFields GET /edgemodules/fields Get Fields
EdgeModulesApi getResources GET /edgemodules/resources Get EdgeModules Resources
EdgeModulesApi getResourcesFields GET /edgemodules/resources/fields Get Resource Fields
EdgeModulesApi registerModule POST /edgemodules Add Module
EdgeModulesApi registerModuleResource POST /edgemodules/{mname}/resources Add Module Resource
EdgeModulesApi unregisterModule DELETE /edgemodules/{mname} Delete Module
EdgeModulesApi unregisterModuleResource DELETE /edgemodules/{mname}/resources/{name} Delete Module Resource
EdgeModulesApi updateModule PUT /edgemodules/{mname} Update Module
EdgeModulesApi updateModuleResource PUT /edgemodules/{mname}/resources/{name} Update Module Resource
EdgeModulesInvokersApi deleteResourceEndpoint DELETE /edgemodules/{mname}/{rname} Invoke Resource Delete Method
EdgeModulesInvokersApi deleteResourceEndpointItem DELETE /edgemodules/{mname}/{rname}/{wildcard} Invoke Resource/_* Delete Method
EdgeModulesInvokersApi getResourceEndpoint GET /edgemodules/{mname}/{rname} Invoke Resource Get Method
EdgeModulesInvokersApi getResourceEndpointItem GET /edgemodules/{mname}/{rname}/{wildcard} Invoke Resource/_* Get Method
EdgeModulesInvokersApi patchResourceEndpoint PATCH /edgemodules/{mname}/{rname} Invoke Resource Patch Method
EdgeModulesInvokersApi patchResourceEndpointItem PATCH /edgemodules/{mname}/{rname}/{wildcard} Invoke Resource/_* Patch Method
EdgeModulesInvokersApi postResourceEndpoint POST /edgemodules/{mname}/{rname} Invoke Resource Post Method
EdgeModulesInvokersApi postResourceEndpointItem POST /edgemodules/{mname}/{rname}/{wildcard} Invoke Resource/_* Post Method
EdgeModulesInvokersApi putResourceEndpoint PUT /edgemodules/{mname}/{rname} Invoke Resource Put Method
EdgeModulesInvokersApi putResourceEndpointItem PUT /edgemodules/{mname}/{rname}/{wildcard} Invoke Resource/_* Put Method
GroupsApi addGroup POST /groups Add Group
GroupsApi deleteGroup DELETE /groups/{item} Delete Group
GroupsApi getGroup GET /groups/{item} Get Group
GroupsApi getGroupFields GET /groups/fields Get Fields
GroupsApi getGroups GET /groups Get Groups
GroupsApi updateGroup PUT /groups/{item} Update Group
InstallationsApi addInstallation POST /installations Add Installation
InstallationsApi deleteInstallation DELETE /installations/{id} Delete Installation
InstallationsApi getChannels GET /installations/channels Get Installation Channels
InstallationsApi getInstallation GET /installations/{id} Get Installation
InstallationsApi getInstallationFields GET /installations/fields Get Fields
InstallationsApi getInstallations GET /installations Get Installations
InstallationsApi updateInstallation PUT /installations/{id} Update Installation
PushApi send POST /push Send Push
UsersApi addUser POST /users Add User
UsersApi deleteUser DELETE /users/{id} Delete User
UsersApi getUser GET /users/{id} Get User
UsersApi getUserFields GET /users/fields Get Fields
UsersApi getUserGroups GET /users/{id}/groups Get User Groups
UsersApi getUsers GET /users Get Users
UsersApi loginUser POST /users/login Log In
UsersApi logoutUser POST /users/logout sPostLogoutSummaryTitle
UsersApi signupUser POST /users/signup Sign Up User
UsersApi updateUser PUT /users/{id} Update User
VersionApi getVersion GET /version Get version

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

You can’t perform that action at this time.