Skip to content

Latest commit

 

History

History
206 lines (144 loc) · 7.46 KB

RelationusageApi.md

File metadata and controls

206 lines (144 loc) · 7.46 KB
Raw

BioLinkApi.RelationusageApi

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

Method HTTP request Description
getRelationUsageBetweenResource GET /relation/usage/between/{subject_category}/{object_category} All relations used plus count of associations
getRelationUsagePivotLabelResource GET /relation/usage/pivot/label Relation usage count for all subj x obj category combinations, showing label
getRelationUsagePivotResource GET /relation/usage/pivot/ Relation usage count for all subj x obj category combinations
getRelationUsageResource GET /relation/usage/ All relations used plus count of associations

getRelationUsageBetweenResource

[AssociationResults] getRelationUsageBetweenResource(objectCategory, subjectCategory, opts)

All relations used plus count of associations

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.RelationusageApi();

var objectCategory = "objectCategory_example"; // String | 

var subjectCategory = "subjectCategory_example"; // String | 

var opts = { 
  'subjectTaxon': "subjectTaxon_example", // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
  'evidence': "evidence_example" // String | Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default)                     or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2.                     
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getRelationUsageBetweenResource(objectCategory, subjectCategory, opts, callback);

Parameters

Name Type Description Notes
objectCategory String
subjectCategory String
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
evidence String Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default) or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2. [optional]

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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

getRelationUsagePivotLabelResource

[AssociationResults] getRelationUsagePivotLabelResource(opts)

Relation usage count for all subj x obj category combinations, showing label

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.RelationusageApi();

var opts = { 
  'subjectTaxon': "subjectTaxon_example", // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
  'evidence': "evidence_example" // String | Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default)                     or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2.                     
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getRelationUsagePivotLabelResource(opts, callback);

Parameters

Name Type Description Notes
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
evidence String Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default) or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2. [optional]

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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

getRelationUsagePivotResource

[AssociationResults] getRelationUsagePivotResource(opts)

Relation usage count for all subj x obj category combinations

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.RelationusageApi();

var opts = { 
  'subjectTaxon': "subjectTaxon_example", // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
  'evidence': "evidence_example" // String | Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default)                     or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2.                     
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getRelationUsagePivotResource(opts, callback);

Parameters

Name Type Description Notes
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
evidence String Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default) or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2. [optional]

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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

getRelationUsageResource

[AssociationResults] getRelationUsageResource(opts)

All relations used plus count of associations

Example

var BioLinkApi = require('bio_link_api');

var apiInstance = new BioLinkApi.RelationusageApi();

var opts = { 
  'subjectTaxon': "subjectTaxon_example", // String | SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default
  'evidence': "evidence_example" // String | Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default)                     or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2.                     
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getRelationUsageResource(opts, callback);

Parameters

Name Type Description Notes
subjectTaxon String SUBJECT TAXON id, e.g. NCBITaxon:9606. Includes inferred by default [optional]
evidence String Object id, e.g. ECO:0000501 (for IEA; Includes inferred by default) or a specific publication or other supporting ibject, e.g. ZFIN:ZDB-PUB-060503-2. [optional]

Return type

[AssociationResults]

Authorization

No authorization required

HTTP request headers

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