CCF-API Documentation Javascript
ccfOpenapiClient = import("https://cdn.skypack.dev/@ccf-openapi/js-client@1.1.2");
host = "https://ccf-api.hubmapconsortium.org/v1";
apiClient = new ccfOpenapiClient.ApiClient(host);
apiInstance = new ccfOpenapiClient.DefaultApi(apiClient);
status = await apiInstance.dbStatus();
sparqlGet = await apiInstance.sparql('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');
sparqlQueryRequest = new ccfOpenapiClient.SparqlQueryRequest('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');
sparql_post = apiInstance.sparqlPost(sparqlQueryRequest);
aggregateResults = await apiInstance.aggregateResults({
'age': new ccfOpenapiClient.MinMax(45.0, 60.0),
'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),
'cache': true,
'ontologyTerms': ["http://purl.obolibrary.org/obo/UBERON_0000955",],
'cellTypeTerms': ["http://purl.obolibrary.org/obo/CL_0000000",],
'providers': [],
'sex': "female",
'spatial': [{"x":84.0,"y":146.0,"z":53.0,"radius":12.0,"target":"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain"},],
'technologies': [],
'token': ""
})
apiInstance.getSpatialPlacement({
"target_iri": "http://purl.org/ccf/latest/ccf.owl#VHFemale",
"rui_location": {
"@context": "https://hubmapconsortium.github.io/hubmap-ontology/ccf-context.jsonld",
"@id": "http://purl.org/ccf/1.5/f7130161-ad0a-4801-b5a4-f6297e0f1869",
"@type": "SpatialEntity",
"creator": "Bruce Herr",
"creator_first_name": "Bruce",
"creator_last_name": "Herr",
"creation_date": "2022-04-27",
"ccf_annotations": ["http://purl.obolibrary.org/obo/UBERON_0002015", "http://purl.obolibrary.org/obo/UBERON_0000362", "http://purl.obolibrary.org/obo/UBERON_0004200", "http://purl.obolibrary.org/obo/UBERON_0001225", "http://purl.obolibrary.org/obo/UBERON_0001284", "http://purl.obolibrary.org/obo/UBERON_0002189"],
"x_dimension": 11,
"y_dimension": 12,
"z_dimension": 13,
"dimension_units": "millimeter",
"placement": {
"@context": "https://hubmapconsortium.github.io/hubmap-ontology/ccf-context.jsonld",
"@id": "http://purl.org/ccf/1.5/f7130161-ad0a-4801-b5a4-f6297e0f1869_placement",
"@type": "SpatialPlacement",
"target": "http://purl.org/ccf/latest/ccf.owl#VHFLeftKidneyV1.1",
"placement_date": "2022-04-27",
"x_scaling": 1,
"y_scaling": 1,
"z_scaling": 1,
"scaling_units": "ratio",
"x_rotation": -61,
"y_rotation": 50,
"z_rotation": -84,
"rotation_order": "XYZ",
"rotation_units": "degree",
"x_translation": 20.149,
"y_translation": 109.963,
"z_translation": 38.79,
"translation_units": "millimeter"
}
}
});
apiInstance.gtexRuiLocations({cache: false})
apiInstance.ontologyTermOccurences({
'age': new ccfOpenapiClient.MinMax(45.0, 60.0),
'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),
'cache': true,
'ontologyTerms': ["http://purl.obolibrary.org/obo/UBERON_0000955",],
'cellTypeTerms': ["http://purl.obolibrary.org/obo/CL_0000000",],
'providers': [],
'sex': "female",
'spatial': [{"x":84.0,"y":146.0,"z":53.0,"radius":12.0,"target":"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain"},],
'technologies': [],
'token': ""
});
apiInstance.cellTypeTermOccurences({
'age': new ccfOpenapiClient.MinMax(45.0, 60.0),
'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),
'cache': true,
'ontologyTerms': ["http://purl.obolibrary.org/obo/UBERON_0000955",],
'cellTypeTerms': ["http://purl.obolibrary.org/obo/CL_0000000",],
'providers': [],
'sex': "female",
'spatial': [{"x":84.0,"y":146.0,"z":53.0,"radius":12.0,"target":"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain"},],
'technologies': [],
'token': ""
});
apiInstance.ontologyTreeModel();
apiInstance.cellTypeTreeModel({cache: false});
apiInstance.providerNames({cache: true});
apiInstance.referenceOrgans({cache: true});
apiInstance.referenceOrganScene(({organ_iri : "http://purl.obolibrary.org/obo/UBERON_0004539"}));
apiInstance.scene({
'age': new ccfOpenapiClient.MinMax(45.0, 60.0),
'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),
'cache': true,
'ontologyTerms': ["http://purl.obolibrary.org/obo/UBERON_0000955",],
'cellTypeTerms': ["http://purl.obolibrary.org/obo/CL_0000000",],
'providers': [],
'sex': "female",
'spatial': [{"x":84.0,"y":146.0,"z":53.0,"radius":12.0,"target":"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain"},],
'technologies': [],
'token': ""
});
apiInstance.technologyNames(({cache: false}));
apiInstance.tissueBlocks({
'age': new ccfOpenapiClient.MinMax(45.0, 60.0),
'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),
'cache': true,
'ontologyTerms': ["http://purl.obolibrary.org/obo/UBERON_0000955",],
'cellTypeTerms': ["http://purl.obolibrary.org/obo/CL_0000000",],
'providers': [],
'sex': "female",
'spatial': [{"x":84.0,"y":146.0,"z":53.0,"radius":12.0,"target":"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain"},],
'technologies': [],
'token': "",
'organ_iri': "http://purl.obolibrary.org/obo/UBERON_0004539"
});
apiInstance.dbStatus(({token:'abcdefgh12334'}));
Purpose-built for displays of data
Observable is your go-to platform for exploring data and creating expressive data visualizations. Use reactive JavaScript notebooks for prototyping and a collaborative canvas for visual data exploration and dashboard creation.
