Skip to content

Latest commit

 

History

History
331 lines (236 loc) · 8.38 KB

VariationsetApi.md

File metadata and controls

331 lines (236 loc) · 8.38 KB

VariationsetApi

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

Method HTTP request Description
deleteVariantSetItem DELETE /variation/set/{id} Deletes variant set
getAnalyze GET /variation/set/analyze/{id} Returns list of matches
getVariantSetItem GET /variation/set/{id} Returns a variant set
getVariantSetsArchiveCollection GET /variation/set/archive/{year}/{month}/{day}/ Returns list of variant sets from a specified time period
getVariantSetsCollection GET /variation/set/ Returns list of variant sets
postVariantSetsCollection POST /variation/set/ Creates a new variant set
putVariantSetItem PUT /variation/set/{id} Updates a variant set

deleteVariantSetItem

deleteVariantSetItem(id, id2, id3)

Deletes variant set

Example

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


VariationsetApi apiInstance = new VariationsetApi();
String id = "id_example"; // String | 
String id2 = "id_example"; // String | 
String id3 = "id_example"; // String | 
try {
    apiInstance.deleteVariantSetItem(id, id2, id3);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#deleteVariantSetItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
id2 String
id3 String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getAnalyze

List<Association> getAnalyze(id)

Returns list of matches

Example

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


VariationsetApi apiInstance = new VariationsetApi();
String id = "id_example"; // String | 
try {
    List<Association> result = apiInstance.getAnalyze(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#getAnalyze");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

List<Association>

Authorization

No authorization required

HTTP request headers

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

getVariantSetItem

VariantSet getVariantSetItem(id)

Returns a variant set

Example

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


VariationsetApi apiInstance = new VariationsetApi();
String id = "id_example"; // String | 
try {
    VariantSet result = apiInstance.getVariantSetItem(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#getVariantSetItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

VariantSet

Authorization

No authorization required

HTTP request headers

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

getVariantSetsArchiveCollection

PageOfVariantSets getVariantSetsArchiveCollection(day, year, month, perPage, page)

Returns list of variant sets from a specified time period

Example

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


VariationsetApi apiInstance = new VariationsetApi();
Integer day = 56; // Integer | 
Integer year = 56; // Integer | 
Integer month = 56; // Integer | 
Integer perPage = 10; // Integer | Results per page {error_msg}
Integer page = 1; // Integer | Page number
try {
    PageOfVariantSets result = apiInstance.getVariantSetsArchiveCollection(day, year, month, perPage, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#getVariantSetsArchiveCollection");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
day Integer
year Integer
month Integer
perPage Integer Results per page {error_msg} [optional] [default to 10]
page Integer Page number [optional] [default to 1]

Return type

PageOfVariantSets

Authorization

No authorization required

HTTP request headers

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

getVariantSetsCollection

PageOfVariantSets getVariantSetsCollection(perPage, page)

Returns list of variant sets

Example

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


VariationsetApi apiInstance = new VariationsetApi();
Integer perPage = 10; // Integer | Results per page {error_msg}
Integer page = 1; // Integer | Page number
try {
    PageOfVariantSets result = apiInstance.getVariantSetsCollection(perPage, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#getVariantSetsCollection");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
perPage Integer Results per page {error_msg} [optional] [default to 10]
page Integer Page number [optional] [default to 1]

Return type

PageOfVariantSets

Authorization

No authorization required

HTTP request headers

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

postVariantSetsCollection

postVariantSetsCollection(payload)

Creates a new variant set

Example

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


VariationsetApi apiInstance = new VariationsetApi();
VariantSet payload = new VariantSet(); // VariantSet | 
try {
    apiInstance.postVariantSetsCollection(payload);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#postVariantSetsCollection");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
payload VariantSet

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

putVariantSetItem

putVariantSetItem(id, id2, payload)

Updates a variant set

Example

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


VariationsetApi apiInstance = new VariationsetApi();
String id = "id_example"; // String | 
String id2 = "id_example"; // String | 
VariantSet payload = new VariantSet(); // VariantSet | 
try {
    apiInstance.putVariantSetItem(id, id2, payload);
} catch (ApiException e) {
    System.err.println("Exception when calling VariationsetApi#putVariantSetItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
id2 String
payload VariantSet

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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