29:null 2a:["$","title",null,{"children":"CCF-API Documentation Javascript | Cyberinfrastructure for Network Science Center (CNS) | Observable"}] 2f:T50e,### INDEX 1. [Installation](https://observablehq.com/@pramodcnsiu/javascript-ccf-api-documentation#cell-124) 2. [Imports](#imports) 3. [Configuration](#config) 4. [Methods](#methods) 1. [Database Check](#db_status) 2. [Run a Sparql query](#sparql_get) 3. [Run a Sparql query (POST)](#sparql_post) 4. [Get aggregate results / statistics](#agg_results) 5. [get Spatial Placement Request](#spatial_entity) 6. [Get all hubmap rui locations](#rui_loc) 7. [Get number of ontology term occurrences for a search](#ontology_term) 8. [Get number of cell type term occurrences for a search](#cell_term_occ) 9. [Get ontology term tree nodes](#ontology_nodes) 10. [Get cell type tree nodes](#cell_nodes) 11. [Get tissue provider names (for filtering)](#providers) 12. [Get all reference organs](#ref_organs) 13. [Get all nodes to form the 3D scene for an organ](#3d_scene) 14. [Get all nodes to form the 3D scene of reference body, organs, and tissues](#nodes_3d) 15. [Get technology names (for filtering)](#tech) 16. [Get Tissue Block Results](#tissue_block) 17. [Token](#token_usage) *** [Click here](https://github.com/hubmapconsortium/ccf-ui/blob/main/ccf-api-usage.ipynb) to view the documentation for ccf-api python module. 30:T496,*** #### Get aggregate results / statistics

Accepted Parameters:
    age - (MinMax) (optional) (min = 1.0; max = 110.0)
    bmi - (MinMax) (optional) (min = 13.0; max = 83.0)
    cache - (boolean)  (optional) (defaults to True)
    sex - (string)  (optional) (male, female, both)
    technologies - (string) (optional) (List of technologies - api_instance.technology_names)
    providers - (string) (optional) 
    ontology_terms - (string) (optional) 
    cell_type_terms - (string) (optional) 
    spatial - SpatialSearch(x, y, z, radius, target) (optional) 
    token - (string) (optional)

*** ```javascript const 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': "" }); ``` ***31:T1352,*** #### Given a SpatialEntity already placed relative to a reference SpatialEntity retrieve a new direct SpatialPlacement to the given SpatialEntity IRI More Info : https://ccf-api.hubmapconsortium.org/#/operations/get-spatial-placement

Accepted Parameters:
    get_spatial_placement_request = {
        "target_iri": (string) (required)
        "rui_location": {
            A Spatial Entity defines a bounded cartesian space and the units it is measured in.
            It typically represents a real world thing, e.g., a human body, a human kidney, a tissue section,
            or an individual cell.
            
            "@id": string (required)
            "@type": (string) (required) (allowed value: SpatialEntity)
            
            "entityId": string (optional) (Identifier of the entity the spatial object represents)
            "ccf_annotations": array[string] (optional) (Annotations attached to the entity.)
            "representation_of": string (optional) (Identifier for the item the spatial object represents.)
            "reference_organ": string (optional) (Identifier for the organ the spatial object represents.)
            
            "creator": (string) (optional)
            "creator_first_name": (string) (optional)
            "creator_last_name": (string) (optional)
            "creator_orcid": (string) (optional)
            "creation_date": (string),
            
            "x_dimension": (number) (required),
            "y_dimension": (number) (required),
            "z_dimension": (number) (required),
            "dimension_units": (string) (required) (default: millimeters),
            
            "label": (string) (optional)
            "comment": (string) (optional)
            "rui_rank": (integer) (optional)
            "sex": (string) (optional)
            "side": (string) (optional) (Used for organs that come in pairs to distinguish between them, i.e. kidneys, etc)
            "slice_count": (integer) (optional)
            "slice_thickness": (number) (optional)
            
            
            "placement": {
                "@id": (string) (required),
                "@type": (string) (required) (allowed value: SpatialEntity),
                "placement_date": string,
                "x_translation": (number) (required),
                "y_translation": (number) (required),
                "z_translation": (number) (required),
                "translation_units": (number) (required) (allowed value: millimeters),
                "x_rotation": (number) (required),
                "y_rotation": (number) (required),
                "z_rotation": (number) (required),
                "rotation_units": (string) (required) (allowed value: degree),
                "x_scaling": (number) (required),
                "y_scaling": (number) (required),
                "z_scaling": (number)  (optional),
                "scaling_units": (string) (required) (allowed value: degree),
                "target": (string) (required),
        }
            
        }
    }

*** ```javascript const spatialPlacement = await 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" } } }); ``` ***32:T6e3,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" } } });33:T4b4,*** #### Get number of ontology term occurrences for a search

Accepted Parameters:
    age - (MinMax) (optional) (min = 1.0; max = 110.0)
    bmi - (MinMax) (optional) (min = 13.0; max = 83.0)
    cache - (boolean)  (optional) (defaults to True)
    sex - (string)  (optional) (male, female, both)
    technologies - (string) (optional) (List of technologies - api_instance.technology_names)
    providers - (string) (optional) 
    ontology_terms - (string) (optional) 
    cell_type_terms - (string) (optional) 
    spatial - SpatialSearch(x, y, z, radius, target) (optional) 
    token - (string) (optional)

*** ```javscript const ontologyTermOccurences = await 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': "" }); ``` ***34:T4b3,*** #### Get number of cell type term occurrences for a search

Accepted Parameters:
    age - (MinMax) (optional) (min = 1.0; max = 110.0)
    bmi - (MinMax) (optional) (min = 13.0; max = 83.0)
    cache - (boolean)  (optional) (defaults to True)
    sex - (string)  (optional) (male, female, both)
    technologies - (string) (optional) (List of technologies - api_instance.technology_names)
    providers - (string) (optional) 
    ontology_terms - (string) (optional) 
    cell_type_terms - (string) (optional) 
    spatial - SpatialSearch(x, y, z, radius, target) (optional) 
    token - (string) (optional)

*** ```javascript const cellTermOccurences = await 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': "" }); ``` ***35:T4a7,*** #### Get all nodes to form the 3D scene of reference body, organs, and tissues

Accepted Parameters:
    age - (MinMax) (optional) (min = 1.0; max = 110.0)
    bmi - (MinMax) (optional) (min = 13.0; max = 83.0)
    cache - (boolean)  (optional) (defaults to True)
    sex - (string)  (optional) (male, female, both)
    technologies - (string) (optional) (List of technologies - api_instance.technology_names)
    providers - (string) (optional) 
    ontology_terms - (string) (optional) 
    cell_type_terms - (string) (optional) 
    spatial - SpatialSearch(x, y, z, radius, target) (optional) 
    token - (string) (optional)

*** ```javascript const scene3D = apiInstance.scene({ 'age': new ccf_openapi_client.MinMax(45.0, 60.0), 'bmi': new ccf_openapi_client.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': "" }); ``` ***36:T489,*** #### Get Tissue Block Results

Accepted Parameters:
    age - (MinMax) (optional) (min = 1.0; max = 110.0)
    bmi - (MinMax) (optional) (min = 13.0; max = 83.0)
    cache - (boolean)  (optional) (defaults to True)
    sex - (string)  (optional) (male, female, both)
    technologies - (string) (optional) (List of technologies - api_instance.technology_names)
    providers - (string) (optional) 
    ontology_terms - (string) (optional) 
    cell_type_terms - (string) (optional) 
    spatial - SpatialSearch(x, y, z, radius, target) (optional) 
    token - (string) (optional)

*** ```javascript const tissueBlocks = await apiInstance.tissueBlocks({ 'age': new ccf_openapi_client.MinMax(45.0, 60.0), 'bmi': new ccf_openapi_client.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': "" }); ``` ***37:[] 2d:{"id":"2cbae8742d221065","slug":"ccf-api-documentation-javascript","title":"CCF-API Documentation Javascript","thumbnail":"057b4bfee678b644a9a7380b74686246037f6204116052b7cc455af9a663ab71","access_level":"public","create_time":"$D2023-06-14T15:08:56.323Z","update_time":"$D2024-05-21T19:34:47.796Z","view_time":null,"first_public_time":"$D2023-06-14T15:08:56.323Z","has_unpublished_edits":null,"fork":{"id":"da08368f68b7a5c1","slug":"javascript-ccf-api-documentation","title":"CCF-API Documentation","owner":{"id":"f3b87c359b2909f2","login":"pramodcnsiu","name":"pramod"}},"stars":0,"starred":false,"owner":{"type":"team","id":"32d3512275cdc547","login":"cns-iu","name":"Cyberinfrastructure for Network Science Center (CNS)","avatar_url":"https://avatars-next.observableusercontent.com/eeb7b299aab3c109232aeb3b2592722732bc9bd4ddc2f0a2cb01fccc3bb80494","tier":"starter_2024"},"version":443,"publish_version":null,"role":null,"authored":false,"authors":[{"type":"individual","id":"3953c1990ca31638","login":"pnbhakta","name":"Pramod Bhakta","avatar_url":"https://avatars-next.observableusercontent.com/274b09ab62fea3049cc1fc310561fd9355b8a7bc9f58ededa70f044672d5e688","tier":null}],"members":[{"type":"team","id":"32d3512275cdc547","login":"cns-iu","name":"Cyberinfrastructure for Network Science Center (CNS)","avatar_url":"https://avatars-next.observableusercontent.com/eeb7b299aab3c109232aeb3b2592722732bc9bd4ddc2f0a2cb01fccc3bb80494","tier":"starter_2024","role":"editor"},{"type":"individual","id":"3953c1990ca31638","login":"pnbhakta","name":"Pramod Bhakta","avatar_url":"https://avatars-next.observableusercontent.com/274b09ab62fea3049cc1fc310561fd9355b8a7bc9f58ededa70f044672d5e688","tier":null,"role":"editor"}],"comments":[],"custom_thumbnail":false,"trashed":false,"lapsed":null,"subscribed":null,"forks":0,"collection":{"id":"6bd654706ac5e46b","slug":"hra-api-usage","title":"HRA API Usage","owner":{"id":"32d3512275cdc547","login":"cns-iu","name":"Cyberinfrastructure for Network Science Center (CNS)"}},"type":"notebook","body":{"title":"CCF-API Documentation Javascript","cells":[{"id":243,"value":"# CCF-API Documentation Javascript","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":424,"value":"$2f","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":124,"value":"\n### Installation\n#### ccf-openapi js-client can be installed via [npm](https://www.npmjs.com/package/@ccf-openapi/js-client) using:\n***\n``` javascript\nnpm i @ccf-openapi/js-client\n```\n***\n#### For Angular or typescript modules please checkout this [page](https://www.npmjs.com/search?q=ccf-openapi)","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":136,"value":"\n### Imports\n\nWe import the ccf-openapi js-client as follows:\n***\n``` javascript\nconst ccfOpenapiClient = require('@ccf-openapi/js-client');\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":0,"value":"ccfOpenapiClient = import(\"https://cdn.skypack.dev/@ccf-openapi/js-client@1.1.2\");","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":169,"value":"***\n\n### Configuration\n
\nccf-openapi can fetch data from \n> CCF-API: https://ccf-api.hubmapconsortium.org/v1
\n> Staging Server: https://r5i95k35v5.us-east-2.awsapprunner.com/v1
\n> You could also use any other instance that you decide to host our code on\n\nYou can get more information about our APIs [here](https://ccf-api.hubmapconsortium.org/#/).\n\nYou'll need to point the host in the configuration to one of the links: \n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":25,"value":"host = \"https://ccf-api.hubmapconsortium.org/v1\";","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":297,"value":"***\n\n### Creating the API Instance\nWe will need to create an instance of ApiClient from ccfOpenapiClient . The host we created above will be passed as a parameter for the constructor. \n
\n***\n``` javascript\nconst apiClient = new ccfOpenapiClient.ApiClient(host);\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":12,"value":"apiClient = new ccfOpenapiClient.ApiClient(host);","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":171,"value":"***\nUsing the instance of ApiClient, we create an instance of DefaultApi from the ccfOpenapiClient module. This instance represents the API interface and provides methods to interact with the API endpoints defined in the OpenAPI specification.\n
\n***\n```javascript\nconst api_instance = new ccfOpenapiClient.DefaultApi(apiClient);\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":27,"value":"apiInstance = new ccfOpenapiClient.DefaultApi(apiClient);","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":319,"value":"

\n\n### Methods\n
\nccfOpenapiClient provides multiple methods which we have described below. Each method is described in more detail below : ","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":336,"value":"***\n\n#### Database Status\nOn first run the database might take some time to be ready, so the initial requests might take a little longer.\n

\nAccepted Parameters:\n    token - (string) (optional)\n

\n_{_{*You can also run this method on loop until it's ready and then try the next methods.\n***\n``` javascript\nconst status = await api_instance.dbStatus();\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":29,"value":"status = await apiInstance.dbStatus();","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":175,"value":"***\n\n#### Run a SPARQL query\n\nAccepted Parameters: \n token - (string) (optional)\n format - (string) (optional) (use only application/json in format, any other formats will result in errors.)\n query - (string) (required)\n
\n***\n```javascript\nconst sparqlGet = await api_instance.sparql('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":31,"value":"sparqlGet = await apiInstance.sparql('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":179,"value":"***\n\n#### Run a SPARQL query (POST)\n\nAccepted Parameters:\n token - (string) (optional)\n format - (string) (optional) (use only application/json in format, any other formats will result in errors.)\n sparqlQueryRequest - { \"query\": \"\" } (required)\n
\n***\n```javascript\nconst sparqlQueryRequest = new ccfOpenapiClient.SparqlQueryRequest('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":42,"value":"sparqlQueryRequest = new ccfOpenapiClient.SparqlQueryRequest('SELECT * WHERE { ?sub ?pred ?obj . } LIMIT 10');","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":181,"value":"***\n```javascript\nconst sparqlPost = api_instance.sparqlPost(sparqlQueryRequest);\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":37,"value":"sparql_post = apiInstance.sparqlPost(sparqlQueryRequest);","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":186,"value":"$30","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":59,"value":"aggregateResults = await apiInstance.aggregateResults({\n 'age': new ccfOpenapiClient.MinMax(45.0, 60.0),\n 'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),\n 'cache': true,\n 'ontologyTerms': [\"http://purl.obolibrary.org/obo/UBERON_0000955\",],\n 'cellTypeTerms': [\"http://purl.obolibrary.org/obo/CL_0000000\",],\n 'providers': [],\n 'sex': \"female\",\n 'spatial': [{\"x\":84.0,\"y\":146.0,\"z\":53.0,\"radius\":12.0,\"target\":\"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain\"},],\n 'technologies': [],\n 'token': \"\"\n})","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":190,"value":"$31","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":76,"value":"$32","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":195,"value":"***\n\n#### Get all hubmap rui locations (if enabled)\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst ruiLocations = await apiInstance.gtexRuiLocations({cache: false})\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":79,"value":"apiInstance.gtexRuiLocations({cache: false})","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":200,"value":"$33","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":83,"value":"apiInstance.ontologyTermOccurences({\n 'age': new ccfOpenapiClient.MinMax(45.0, 60.0),\n 'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),\n 'cache': true,\n 'ontologyTerms': [\"http://purl.obolibrary.org/obo/UBERON_0000955\",],\n 'cellTypeTerms': [\"http://purl.obolibrary.org/obo/CL_0000000\",],\n 'providers': [],\n 'sex': \"female\",\n 'spatial': [{\"x\":84.0,\"y\":146.0,\"z\":53.0,\"radius\":12.0,\"target\":\"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain\"},],\n 'technologies': [],\n 'token': \"\"\n});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":208,"value":"$34","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":85,"value":"apiInstance.cellTypeTermOccurences({\n 'age': new ccfOpenapiClient.MinMax(45.0, 60.0),\n 'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),\n 'cache': true,\n 'ontologyTerms': [\"http://purl.obolibrary.org/obo/UBERON_0000955\",],\n 'cellTypeTerms': [\"http://purl.obolibrary.org/obo/CL_0000000\",],\n 'providers': [],\n 'sex': \"female\",\n 'spatial': [{\"x\":84.0,\"y\":146.0,\"z\":53.0,\"radius\":12.0,\"target\":\"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain\"},],\n 'technologies': [],\n 'token': \"\"\n});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":210,"value":"***\n\n#### Get ontology term tree nodes\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst treeModel = api_instance.ontologyTreeModel();\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":87,"value":"apiInstance.ontologyTreeModel();","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":213,"value":"***\n\n#### Get cell type tree nodes\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst cellTreeModel = await apiInstance.cellTypeTreeModel({cache: false});\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":93,"value":"apiInstance.cellTypeTreeModel({cache: false});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":215,"value":"***\n\n#### Get tissue provider names (for filtering)\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst providers = await apiInstance.providerNames({cache: true});\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":95,"value":"apiInstance.providerNames({cache: true});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":217,"value":"***\n\n#### Get all reference organs\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst refOrgans = await apiInstance.referenceOrgans({cache: true});\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":98,"value":"apiInstance.referenceOrgans({cache: true});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":219,"value":"***\n\n#### Get all nodes to form the 3D scene for an organ\n\nAccepted Parameters:\n age - (MinMax) (optional) (min = 1.0; max = 110.0)\n bmi - (MinMax) (optional) (min = 13.0; max = 83.0)\n cache - (boolean) (optional) (defaults to True)\n sex - (string) (optional) (male, female, both)\n technologies - (string) (optional) (List of technologies - api_instance.technology_names)\n providers - (string) (optional) \n ontology_terms - (string) (optional) \n cell_type_terms - (string) (optional) \n spatial - SpatialSearch(x, y, z, radius, target) (optional) \n token - (string) (optional)\n organ-iri - (string) (required)\n
\n***\n```javascript\nconst refOrganScene = await apiInstance.referenceOrganScene(({organ_iri : \"http://purl.obolibrary.org/obo/UBERON_0004539\"}));\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":101,"value":"apiInstance.referenceOrganScene(({organ_iri : \"http://purl.obolibrary.org/obo/UBERON_0004539\"}));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":221,"value":"$35","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":114,"value":"apiInstance.scene({\n 'age': new ccfOpenapiClient.MinMax(45.0, 60.0),\n 'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),\n 'cache': true,\n 'ontologyTerms': [\"http://purl.obolibrary.org/obo/UBERON_0000955\",],\n 'cellTypeTerms': [\"http://purl.obolibrary.org/obo/CL_0000000\",],\n 'providers': [],\n 'sex': \"female\",\n 'spatial': [{\"x\":84.0,\"y\":146.0,\"z\":53.0,\"radius\":12.0,\"target\":\"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain\"},],\n 'technologies': [],\n 'token': \"\"\n});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":223,"value":"***\n\n#### Get technology names (for filtering)\n\nAccepted Parameters:\n cache - (boolean) (optional)\n token - (string) (optional)\n
\n***\n```javascript\nconst technologyNames = await api_instance.technologyNames(({cache: false}));\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":116,"value":"apiInstance.technologyNames(({cache: false}));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":225,"value":"$36","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":118,"value":"apiInstance.tissueBlocks({\n 'age': new ccfOpenapiClient.MinMax(45.0, 60.0),\n 'bmi': new ccfOpenapiClient.MinMax(65.0, 83.0),\n 'cache': true,\n 'ontologyTerms': [\"http://purl.obolibrary.org/obo/UBERON_0000955\",],\n 'cellTypeTerms': [\"http://purl.obolibrary.org/obo/CL_0000000\",],\n 'providers': [],\n 'sex': \"female\",\n 'spatial': [{\"x\":84.0,\"y\":146.0,\"z\":53.0,\"radius\":12.0,\"target\":\"http://purl.org/ccf/latest/ccf.owl#VHFAllenBrain\"},],\n 'technologies': [],\n 'token': \"\",\n 'organ_iri': \"http://purl.obolibrary.org/obo/UBERON_0004539\"\n});","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":227,"value":"***\n\n#### Token Usage\n***\n```javascript\nconst dbStatus2 = await apiInstance.dbStatus(({token:'abcdefgh12334'}));\n```\n***","pinned":false,"hidden":false,"mode":"md","author":"$undefined","summary":"$undefined","output":"","database":"$undefined"},{"id":120,"value":"apiInstance.dbStatus(({token:'abcdefgh12334'}));","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"}],"files":"$W37","stdlib":"1","titling":"auto"}}
2e:"$2d:body"}}