jaqpot-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.

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/jaqpot-client-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import jaqpot.client.*;
import jaqpot.client.auth.*;
import jaqpot.client.model.*;
import jaqpot.client.api.AaApi;

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

public class AaApiExample {

    public static void main(String[] args) {
        
        AaApi apiInstance = new AaApi();
        String subjectid = "subjectid_example"; // String | 
        String method = "GET"; // String | HTTP method
        String uri = "uri_example"; // String | URI
        try {
            apiInstance.authorize(subjectid, method, uri);
        } catch (ApiException e) {
            System.err.println("Exception when calling AaApi#authorize");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://test.jaqpot.org:8081/jaqpot/services

Class	Method	HTTP request	Description
AaApi	authorize	POST /aa/authorize	Requests authorization from SSO
AaApi	login	POST /aa/login	Creates Security Token
AaApi	logout	POST /aa/logout	Logs out a user
AaApi	validate	POST /aa/validate	Validate authorization token
AlgorithmApi	createAlgorithm	POST /algorithm	Creates Algorithm
AlgorithmApi	deleteAlgorithm	DELETE /algorithm/{id}	Unregisters an algorithm of given ID
AlgorithmApi	getAlgorithm	GET /algorithm/{id}	Finds Algorithm
AlgorithmApi	getAlgorithms	GET /algorithm	Finds all Algorithms
AlgorithmApi	modifyAlgorithm	PATCH /algorithm/{id}	Modifies a particular Algorithm resource
AlgorithmApi	trainModel	POST /algorithm/{id}	Creates Model
BibtexApi	createBibTeX	POST /bibtex	Creates a new BibTeX entry
BibtexApi	createBibTeXGivenID	PUT /bibtex/{id}	Places a new BibTeX entry at a particular URI
BibtexApi	deleteBibTeX	DELETE /bibtex/{id}	Deletes a particular BibTeX resource
BibtexApi	getBibTeX	GET /bibtex/{id}	Returns BibTeX entry
BibtexApi	listBibTeXs	GET /bibtex	Finds all BibTeX entries
BibtexApi	modifyBibTeX	PATCH /bibtex/{id}	Modifies a particular BibTeX resource
DatasetApi	createDataset	POST /dataset	Creates a new Dataset
DatasetApi	createEmptyDataset	POST /dataset/empty	Creates a new empty Dataset
DatasetApi	createQPRFReport	POST /dataset/{id}/qprf	Creates QPRF Report
DatasetApi	createQPRFReportDummy	POST /dataset/{id}/qprf-dummy	Creates QPRF Report
DatasetApi	deleteDataset	DELETE /dataset/{id}	Deletes dataset
DatasetApi	getDataset	GET /dataset/{id}	Finds Dataset by Id
DatasetApi	getDatasetFeatures	GET /dataset/{id}/features	Finds Dataset by Id
DatasetApi	getDatasetMeta	GET /dataset/{id}/meta	Finds Dataset by Id
DatasetApi	listDatasets	GET /dataset	Finds all Datasets
DatasetApi	listFeaturedDatasets	GET /dataset/featured	Finds all Datasets
DatasetApi	mergeDatasets	POST /dataset/merge	Merges Datasets
DoseresponseApi	doseResponse	POST /doseresponse	Creates Dose Response Report
EnmApi	createBundle	POST /enm/bundle	Creates Bundle
EnmApi	createDatasetByStudies	POST /enm/dataset	Creates Dataset
EnmApi	getDescriptorCategories	GET /enm/descriptor/categories	Retrieves descriptor calculation categories
EnmApi	getPropertyCategories	GET /enm/property/categories	Retrieves property categories
FeatureApi	createFeature	POST /feature	Creates a new Feature
FeatureApi	deleteFeature	DELETE /feature/{id}	Deletes a particular Feature resource.
FeatureApi	getFeature	GET /feature/{id}	Finds Feature by ID
FeatureApi	listFeatures	GET /feature	Lists features
FeatureApi	putFeature	PUT /feature/{id}	Places a new Feature at a particular URI
InterlabApi	interLabTest	POST /interlab/test	Creates Interlab Testing Report
ModelApi	deleteModel	DELETE /model/{id}	Deletes a particular Model resource
ModelApi	getModel	GET /model/{id}	Finds Model by Id
ModelApi	getModelPmml	GET /model/{id}/pmml	Finds Model by Id
ModelApi	listFeaturedModels	GET /model/featured	Finds all Models
ModelApi	listModelDependentFeatures	GET /model/{id}/dependent	Lists the dependent features of a Model
ModelApi	listModelIndependentFeatures	GET /model/{id}/independent	Lists the independent features of a Model
ModelApi	listModelPredictedFeatures	GET /model/{id}/predicted	Lists the dependent features of a Model
ModelApi	listModelRequiredFeatures	GET /model/{id}/required	Lists the required features of a Model
ModelApi	listModels	GET /model	Finds all Models
ModelApi	makePrediction	POST /model/{id}	Creates Prediction
PmmlApi	createPMML	POST /pmml	Creates a new PMML entry
PmmlApi	createPMMLSelection	POST /pmml/selection	Creates a new PMML entry
PmmlApi	getPmml	GET /pmml/{id}	Returns PMML entry
PmmlApi	listPmml	GET /pmml	Finds all PMML entries
ReadacrossApi	interLabTestReadAcross	POST /readacross	Creates Read Across Report
ReportApi	createPDF	GET /report/{id}/pdf	Creates PDF from report
ReportApi	getReport	GET /report/{id}	Retrieves Report by id
ReportApi	getReports	GET /report	Retrieves Reports of User
ReportApi	modifyReport	PATCH /report/{id}	Modifies a particular Report resource
ReportApi	removeReport	DELETE /report/{id}	Removes Report by id
TaskApi	deleteTask	DELETE /task/{id}	Deletes a Task of given ID
TaskApi	getTask	GET /task/{id}	Finds Task by Id
TaskApi	listTasks	GET /task	Finds all Tasks
TaskApi	poll	GET /task/{id}/poll	Poll Task by Id
UserApi	getUser	GET /user/{id}	Finds User by Id
UserApi	getUserQuota	GET /user/{id}/quota	Retrieves user's quota
UserApi	listUsers	GET /user	Lists all Users (admins only)
ValidationApi	crossValidateAlgorithm	POST /validation/training_test_cross	Creates Validation Report
ValidationApi	externalValidateAlgorithm	POST /validation/test_set_validation	Creates Validation Report
ValidationApi	splitValidateAlgorithm	POST /validation/training_test_split	Creates Validation Report

Documentation for Models

• Algorithm
• ArrayCalculation
• BibTeX
• BundleData
• DataEntry
• Dataset
• DatasetData
• ErrorReport
• Feature
• FeatureInfo
• MetaInfo
• Model
• Parameter
• Pmml
• Report
• Substance
• Task
• User
• UserQuota

Documentation for Authorization

Authentication schemes defined for the API:

subjectid

• Type: API key
• API key parameter name: subjectid
• Location: HTTP header

Recommendation

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

Author

hampos@me.com