Skip to content

Latest commit

 

History

History
168 lines (125 loc) · 7.6 KB

SearchentityApi.md

File metadata and controls

168 lines (125 loc) · 7.6 KB
Raw

SearchentityApi

All URIs are relative to https://localhost/api

Method HTTP request Description
getAuthocomplete GET /search/entity/autocomplete/{term} Returns list of matches
getAuthocomplete_0 GET /search/entity/query/ Returns list of matches
getSearchEntities GET /search/entity/{term} Returns list of matches

getAuthocomplete

List<Association> getAuthocomplete(term, weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute)

Returns list of matches

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.SearchentityApi;


SearchentityApi apiInstance = new SearchentityApi();
String term = "term_example"; // String | 
List<String> weightedAttribute = Arrays.asList("weightedAttribute_example"); // List<String> | weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001
List<String> attribute = Arrays.asList("attribute_example"); // List<String> | positive attributes, e.g. ontology terms, to include in query
Boolean noise = true; // Boolean | If set, uses noise-tolerant querying, e.g owlsim, boqa
String subjectTaxon = "subjectTaxon_example"; // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
List<String> negativeAttribute = Arrays.asList("negativeAttribute_example"); // List<String> | negative attributes, e.g. ontology terms, to exclude in query
try {
    List<Association> result = apiInstance.getAuthocomplete(term, weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SearchentityApi#getAuthocomplete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
term String
weightedAttribute List<String> weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001 [optional]
attribute List<String> positive attributes, e.g. ontology terms, to include in query [optional]
noise Boolean If set, uses noise-tolerant querying, e.g owlsim, boqa [optional]
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
negativeAttribute List<String> negative attributes, e.g. ontology terms, to exclude in query [optional]

Return type

List<Association>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getAuthocomplete_0

List<Association> getAuthocomplete_0(weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute)

Returns list of matches

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.SearchentityApi;


SearchentityApi apiInstance = new SearchentityApi();
List<String> weightedAttribute = Arrays.asList("weightedAttribute_example"); // List<String> | weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001
List<String> attribute = Arrays.asList("attribute_example"); // List<String> | positive attributes, e.g. ontology terms, to include in query
Boolean noise = true; // Boolean | If set, uses noise-tolerant querying, e.g owlsim, boqa
String subjectTaxon = "subjectTaxon_example"; // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
List<String> negativeAttribute = Arrays.asList("negativeAttribute_example"); // List<String> | negative attributes, e.g. ontology terms, to exclude in query
try {
    List<Association> result = apiInstance.getAuthocomplete_0(weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SearchentityApi#getAuthocomplete_0");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
weightedAttribute List<String> weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001 [optional]
attribute List<String> positive attributes, e.g. ontology terms, to include in query [optional]
noise Boolean If set, uses noise-tolerant querying, e.g owlsim, boqa [optional]
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
negativeAttribute List<String> negative attributes, e.g. ontology terms, to exclude in query [optional]

Return type

List<Association>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getSearchEntities

List<Association> getSearchEntities(term, weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute)

Returns list of matches

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.SearchentityApi;


SearchentityApi apiInstance = new SearchentityApi();
String term = "term_example"; // String | 
List<String> weightedAttribute = Arrays.asList("weightedAttribute_example"); // List<String> | weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001
List<String> attribute = Arrays.asList("attribute_example"); // List<String> | positive attributes, e.g. ontology terms, to include in query
Boolean noise = true; // Boolean | If set, uses noise-tolerant querying, e.g owlsim, boqa
String subjectTaxon = "subjectTaxon_example"; // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
List<String> negativeAttribute = Arrays.asList("negativeAttribute_example"); // List<String> | negative attributes, e.g. ontology terms, to exclude in query
try {
    List<Association> result = apiInstance.getSearchEntities(term, weightedAttribute, attribute, noise, subjectTaxon, negativeAttribute);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SearchentityApi#getSearchEntities");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
term String
weightedAttribute List<String> weighted attributes, specified as a range from 0 to 1 plus an ontology term, e.g. 0.3*HP:0000001 [optional]
attribute List<String> positive attributes, e.g. ontology terms, to include in query [optional]
noise Boolean If set, uses noise-tolerant querying, e.g owlsim, boqa [optional]
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
negativeAttribute List<String> negative attributes, e.g. ontology terms, to exclude in query [optional]

Return type

List<Association>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json