This API provides programmatic access to data registered to the Human Reference Atlas (HRA). See the [HuBMAP HRA Portal](https://humanatlas.io/) for details.
npm install @ccf-openapi/js-clientCcfOpenapiJsClient - JavaScript client for @ccf-openapi/js-client
This API provides programmatic access to data registered to the Human Reference Atlas (HRA).
See the HuBMAP HRA Portal for details.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.2.0
- Package version: 1.2.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
#### npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
``shell`
npm install @ccf-openapi/js-client --save
Finally, you need to build the module:
`shell`
npm run build
##### Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
`shell`
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
`shell`
npm link
To use the link you just defined in your project, switch to the directory you want to use your @ccf-openapi/js-client from, and run:
`shell`
npm link /path/to/
Finally, you need to build the module:
`shell`
npm run build
#### git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
`shell`
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file):
`shell`
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:
`javascript`
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
`javascript
var CcfOpenapiJsClient = require('@ccf-openapi/js-client');
var api = new CcfOpenapiJsClient.DefaultApi()
var opts = {
'age': {key: null}, // {MinMax} Filter result by age.
'ageRange': 10,100, // {String} Filter result by age.
'bmi': {key: null}, // {MinMax} Filter result by bmi.
'bmiRange': 0,40, // {String} Filter result by bmi.
'cache': true, // {Boolean} Hint to cache (or not) the response of this request
'ontologyTerms': ["null"], // {[String]} Filter result by ontology terms.
'cellTypeTerms': ["null"], // {[String]} Filter result by ontology terms.
'biomarkerTerms': ["null"], // {[String]} Filter result by ontology terms.
'consortiums': ["null"], // {[String]} Filter result by consortiums.
'providers': ["null"], // {[String]} Filter result by providers.
'sex': "sex_example", // {String} Filter result by sex.
'spatial': [{"x":10,"y":10,"z":10,"radius":100,"target":"http://purl.org/ccf/latest/ccf.owl#VHMale"},{"x":11,"y":11,"z":11,"radius":101,"target":"http://purl.org/ccf/latest/ccf.owl#VHFemale"}], // {[SpatialSearch]} Filter result by spatial searches.
'technologies': ["null"], // {[String]} Filter result by technologies.
'token': "token_example" // {String} Authentication token to use for authenticated searches
};
api.aggregateResults(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
``
All URIs are relative to https://apps.humanatlas.io/hra-api/v1
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
CcfOpenapiJsClient.DefaultApi | aggregateResults | GET /aggregate-results | Get aggregate results / statistics
CcfOpenapiJsClient.DefaultApi | biomarkerTermOccurences | GET /biomarker-term-occurences | Get number of biomarker type term occurrences for a search
CcfOpenapiJsClient.DefaultApi | biomarkerTreeModel | GET /biomarker-tree-model | Get biomarker tree nodes
CcfOpenapiJsClient.DefaultApi | cellTypeTermOccurences | GET /cell-type-term-occurences | Get number of cell type term occurrences for a search
CcfOpenapiJsClient.DefaultApi | cellTypeTreeModel | GET /cell-type-tree-model | Get cell type tree nodes
CcfOpenapiJsClient.DefaultApi | dbStatus | GET /db-status | Get current status of database
CcfOpenapiJsClient.DefaultApi | getSpatialPlacement | POST /get-spatial-placement | Given a SpatialEntity already placed relative to a reference SpatialEntity, retrieve a new direct SpatialPlacement to the given SpatialEntity IRI
CcfOpenapiJsClient.DefaultApi | gtexRuiLocations | GET /gtex/rui_locations.jsonld | Get all GTEx rui locations (if enabled)
CcfOpenapiJsClient.DefaultApi | hubmapRuiLocations | GET /hubmap/rui_locations.jsonld | Get all hubmap rui locations (if enabled)
CcfOpenapiJsClient.DefaultApi | ontologyTermOccurences | GET /ontology-term-occurences | Get number of ontology term occurrences for a search
CcfOpenapiJsClient.DefaultApi | ontologyTreeModel | GET /ontology-tree-model | Get ontology term tree nodes
CcfOpenapiJsClient.DefaultApi | providerNames | GET /provider-names | Get tissue provider names (for filtering)
CcfOpenapiJsClient.DefaultApi | referenceOrganScene | GET /reference-organ-scene | Get all nodes to form the 3D scene for an organ
CcfOpenapiJsClient.DefaultApi | referenceOrgans | GET /reference-organs | Get all reference organs
CcfOpenapiJsClient.DefaultApi | scene | GET /scene | Get all nodes to form the 3D scene of reference body, organs, and tissues
CcfOpenapiJsClient.DefaultApi | sennetRuiLocations | GET /sennet/rui_locations.jsonld | Get all sennet rui locations (if enabled)
CcfOpenapiJsClient.DefaultApi | sparql | GET /sparql | Run a SPARQL query
CcfOpenapiJsClient.DefaultApi | sparqlPost | POST /sparql | Run a SPARQL query (POST)
CcfOpenapiJsClient.DefaultApi | technologyNames | GET /technology-names | Get technology names (for filtering)
CcfOpenapiJsClient.DefaultApi | tissueBlocks | GET /tissue-blocks | Get Tissue Block Results
- CcfOpenapiJsClient.AggregateCount
- CcfOpenapiJsClient.DatabaseStatus
- CcfOpenapiJsClient.ErrorMessage
- CcfOpenapiJsClient.FlatSpatialPlacement
- CcfOpenapiJsClient.GetSpatialPlacementRequest
- CcfOpenapiJsClient.MinMax
- CcfOpenapiJsClient.OntologyTree
- CcfOpenapiJsClient.OntologyTreeNode
- CcfOpenapiJsClient.SparqlQueryRequest
- CcfOpenapiJsClient.SpatialEntity
- CcfOpenapiJsClient.SpatialEntityCommon
- CcfOpenapiJsClient.SpatialEntityCreator
- CcfOpenapiJsClient.SpatialEntityDimensions
- CcfOpenapiJsClient.SpatialObjectReference
- CcfOpenapiJsClient.SpatialPlacement
- CcfOpenapiJsClient.SpatialPlacementCommon
- CcfOpenapiJsClient.SpatialPlacementRotation
- CcfOpenapiJsClient.SpatialPlacementScaling
- CcfOpenapiJsClient.SpatialPlacementTranslation
- CcfOpenapiJsClient.SpatialSceneNode
- CcfOpenapiJsClient.SpatialSearch
- CcfOpenapiJsClient.TissueBlock
- CcfOpenapiJsClient.TissueCommon
- CcfOpenapiJsClient.TissueDataset
- CcfOpenapiJsClient.TissueDonor
- CcfOpenapiJsClient.TissueSampleCommon
- CcfOpenapiJsClient.TissueSection
Endpoints do not require authorization.