All URIs are relative to https://localhost/api
Method | HTTP request | Description |
---|---|---|
getActivityCollection | GET /cam/activity/ | Returns list of models |
getInstance | GET /cam/instance/{id} | Returns list of matches |
getModel | GET /cam/model/{id} | Returns a complete model |
getModelCollection | GET /cam/model/ | Returns list of ALL models |
getModelCollection_0 | GET /cam/model/properties/ | Returns list of all properties used across all models |
getModelCollection_1 | GET /cam/model/property_values/ | Returns list property-values for all models |
getModelCollection_2 | GET /cam/model/query/ | Returns list of models matching query |
getModelContibutors | GET /cam/instances/ | Returns list of all instances |
getModelContibutors_0 | GET /cam/model/contributors/ | Returns list of all contributors across all models |
getPhysicalInteraction | GET /cam/physical_interaction/ | Returns list of models |
getActivityCollection(opts)
Returns list of models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getActivityCollection(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Association] getInstance(id, opts)
Returns list of matches
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var id = "id_example"; // String |
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInstance(id, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
id | String | ||
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
getModel(id)
Returns a complete model
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var id = "id_example"; // String |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModel(id, callback);
Name | Type | Description | Notes |
---|---|---|---|
id | String |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelCollection()
Returns list of ALL models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelCollection(callback);
This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelCollection_0(opts)
Returns list of all properties used across all models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelCollection_0(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelCollection_1(opts)
Returns list property-values for all models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelCollection_1(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelCollection_2(opts)
Returns list of models matching query
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelCollection_2(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelContibutors()
Returns list of all instances
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelContibutors(callback);
This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getModelContibutors_0()
Returns list of all contributors across all models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getModelContibutors_0(callback);
This endpoint does not need any parameter.
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
getPhysicalInteraction(opts)
Returns list of models
var BioLinkApi = require('bio_link_api');
var apiInstance = new BioLinkApi.CamApi();
var opts = {
'contributor': "contributor_example", // String | string to search for in contributor of model
'title': "title_example" // String | string to search for in title of model
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getPhysicalInteraction(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
contributor | String | string to search for in contributor of model | [optional] |
title | String | string to search for in title of model | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json