Skip to content

Latest commit

 

History

History

generated

README.md

swagger-java-client

Azure Blockchain Workbench REST API

  • API version: v1

The Azure Blockchain Workbench REST API is a Workbench extensibility point, which allows developers to create and manage blockchain applications, manage users and organizations within a consortium, integrate blockchain applications into services and platforms, perform transactions on a blockchain, and retrieve transactional and contract data from a blockchain.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

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

mvn clean install

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

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-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-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-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.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

import java.io.File;
import java.util.*;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        String applicationID = "applicationID_example"; // String | The id of the application.
        try {
            apiInstance.applicationDelete(applicationID);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#applicationDelete");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
ApplicationsApi applicationDelete DELETE /api/v1/applications/{applicationID}
ApplicationsApi applicationDisable PATCH /api/v1/applications/{applicationID}/disable
ApplicationsApi applicationEnable PATCH /api/v1/applications/{applicationID}/enable
ApplicationsApi applicationGet GET /api/v1/applications/{applicationId}
ApplicationsApi applicationsGet GET /api/v1/applications
ApplicationsApi applicationsPost POST /api/v1/applications
ApplicationsApi contractCodeDelete DELETE /api/v1/applications/contractCode/{contractCodeId}
ApplicationsApi contractCodeGet GET /api/v1/applications/contractCode/{contractCodeId}
ApplicationsApi contractCodePost POST /api/v1/applications/{applicationId}/contractCode
ApplicationsApi contractCodesGet GET /api/v1/applications/{applicationID}/contractCode
ApplicationsApi roleAssignmentDelete DELETE /api/v1/applications/{applicationId}/roleAssignments/{roleAssignmentId}
ApplicationsApi roleAssignmentGet GET /api/v1/applications/{applicationId}/roleAssignments/{roleAssignmentId}
ApplicationsApi roleAssignmentsGet GET /api/v1/applications/{applicationId}/roleAssignments
ApplicationsApi roleAssignmentsPost POST /api/v1/applications/{applicationId}/roleAssignments
ApplicationsApi workflowGet GET /api/v1/applications/workflows/{workflowId}
ApplicationsApi workflowsGet GET /api/v1/applications/{applicationId}/workflows
CapabilitiesApi canCreateContract GET /api/v1/capabilities/canCreateContract/{workflowId}
CapabilitiesApi capabilitiesGet GET /api/v1/capabilities
CheckersApi checkApplicationPost POST /api/v1/checkers/checkApplication Check validity of application configuration for Workbench
CheckersApi checkContractCodePost POST /api/v1/checkers/checkContractCode Check validity of application ledger implementation for Workbench
ConnectionsApi blockGet GET /api/v1/ledgers/connections/{connectionId}/blocks/{blockId}
ConnectionsApi blocksGet GET /api/v1/ledgers/connections/{connectionId}/blocks
ConnectionsApi connectionGet GET /api/v1/ledgers/connections/{connectionId}
ConnectionsApi connectionsGet GET /api/v1/ledgers/connections
ConnectionsApi transactionGet GET /api/v1/ledgers/connections/{connectionId}/transactions/{transactionId}
ConnectionsApi transactionsGet GET /api/v1/ledgers/connections/{connectionId}/transactions
ContractsApi contractActionGet GET /api/v1/contracts/{contractId}/actions/{actionId}
ContractsApi contractActionPost POST /api/v1/contracts/{contractId}/actions
ContractsApi contractActionsGet GET /api/v1/contracts/{contractId}/actions
ContractsApi contractGet GET /api/v1/contracts/{contractId}
ContractsApi contractPost POST /api/v1/contracts
ContractsApi contractsGet GET /api/v1/contracts
GraphProxyApi graphProxyUsersGet GET /api/v1/graph-proxy/{version}/users Get Users from AAD Graph
LedgersApi ledgersGet GET /api/v1/ledgers
UsersApi meGet GET /api/v1/users/me
UsersApi userDelete DELETE /api/v1/users/{userID}
UsersApi userGet GET /api/v1/users/{userID}
UsersApi usersGet GET /api/v1/users Get Users
UsersApi usersPost POST /api/v1/users

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