Skip to content

Latest commit

 

History

History
188 lines (128 loc) · 4.35 KB

EnmApi.md

File metadata and controls

188 lines (128 loc) · 4.35 KB

EnmApi

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

Method HTTP request Description
createBundle POST /enm/bundle Creates Bundle
createDatasetByStudies POST /enm/dataset Creates Dataset
getDescriptorCategories GET /enm/descriptor/categories Retrieves descriptor calculation categories
getPropertyCategories GET /enm/property/categories Retrieves property categories

createBundle

String createBundle(body, subjectid)

Creates Bundle

Reads Substances from SubstanceOwner and creates Bundle.

Example

// Import classes:
//import jaqpot.client.ApiException;
//import jaqpot.client.api.EnmApi;


EnmApi apiInstance = new EnmApi();
BundleData body = new BundleData(); // BundleData | Data for bundle creation
String subjectid = "subjectid_example"; // String | 
try {
    String result = apiInstance.createBundle(body, subjectid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnmApi#createBundle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body BundleData Data for bundle creation
subjectid String [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/uri-list

createDatasetByStudies

Task createDatasetByStudies(data, subjectid)

Creates Dataset

Reads Studies from Bundle's Substances, creates Dateaset,calculates Descriptors, returns Dataset

Example

// Import classes:
//import jaqpot.client.ApiException;
//import jaqpot.client.api.EnmApi;


EnmApi apiInstance = new EnmApi();
DatasetData data = new DatasetData(); // DatasetData | 
String subjectid = "subjectid_example"; // String | 
try {
    Task result = apiInstance.createDatasetByStudies(data, subjectid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnmApi#createDatasetByStudies");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
data DatasetData [optional]
subjectid String [optional]

Return type

Task

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/uri-list

getDescriptorCategories

List<Object> getDescriptorCategories()

Retrieves descriptor calculation categories

Example

// Import classes:
//import jaqpot.client.ApiException;
//import jaqpot.client.api.EnmApi;


EnmApi apiInstance = new EnmApi();
try {
    List<Object> result = apiInstance.getDescriptorCategories();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnmApi#getDescriptorCategories");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<Object>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getPropertyCategories

Map<String, Object> getPropertyCategories()

Retrieves property categories

Example

// Import classes:
//import jaqpot.client.ApiException;
//import jaqpot.client.api.EnmApi;


EnmApi apiInstance = new EnmApi();
try {
    Map<String, Object> result = apiInstance.getPropertyCategories();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnmApi#getPropertyCategories");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Map<String, Object>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined