{"openapi":"3.0.1","info":{"title":"NCI EVS Rest API","description":"Endpoints to support searching, metadata, and content retrieval for EVS terminologies. To learn more about how to interact with this api, see the <a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK\">Github evsrestapi-client-SDK project.</a>","termsOfService":"https://evs.nci.nih.gov/ftp1/NCI_Thesaurus/ThesaurusTermsofUse.htm","contact":{"name":"NCI EVS","email":"NCIAppSupport@nih.gov"},"version":"2.5.1.RELEASE"},"servers":[{"url":"/"}],"paths":{"/api/v1/sparql/{terminology}":{"post":{"tags":["Search endpoint"],"summary":"Get SPARQL query results","description":"Perform a SPARQL query for a specified terminology.","operationId":"getSparqlBindings","parameters":[{"name":"terminology","in":"path","description":"Single terminology to search, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"prefixes","in":"query","description":"Use 'true' to use queries with declared prefixes","required":false,"schema":{"type":"boolean"},"example":true},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"SPARQL query to execute on the graph for the specified terminology. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/SPARQL.md' target='_blank'>See here for more information and examples of using SPARQL with EVSRESTAPI</a>.","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapResultList"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/search":{"get":{"tags":["Search endpoint"],"summary":"Get concept search results for a specified terminology","description":"Use cases for search range from very simple term searches, use of paging parameters, additional filters, searches properties, roles, and associations, and so on.  To further explore the range of search options, take a look at the <a href='https://github.com/NCIEVS/evsrestapi-client-SDK' target='_blank'>Github client SDK library created for the NCI EVS Rest API</a>.","operationId":"searchSingleTerminology","parameters":[{"name":"terminology","in":"path","description":"Single terminology to search, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}},{"name":"term","in":"query","description":"The term, phrase, or code to be searched, e.g. 'melanoma'","schema":{"type":"string"}},{"name":"type","in":"query","description":"The match type, one of: contains, match, startsWith, phrase, AND, OR, fuzzy.","schema":{"type":"string"},"example":"contains"},{"name":"sort","in":"query","description":"The search parameter to sort results by","schema":{"type":"string"}},{"name":"ascending","in":"query","description":"Sort ascending (if true) or descending (if false)","schema":{"type":"boolean"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","schema":{"type":"integer","format":"int32"},"example":10},{"name":"conceptStatus","in":"query","description":"Comma-separated list of concept status values to restrict search results by. <p><a href='/api/v1/metadata/ncit/conceptStatuses' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"property","in":"query","description":"Comma-separated list of properties to restrict search results by (see also <i>value</i>). e.g.<ul><li>'P106,P322' for <i>terminology=ncit</i></li><li>'COLOR,SHAPE' for <i>terminology=ncim</i></li></ul><p><a href='/api/v1/metadata/ncit/properties' target='_blank'>Click here for a list of NCI Thesaurus properties</a>.</p><p><a href='/api/v1/metadata/ncim/properties' target='_blank'>Click here for a list of NCI Metathesaurus properties</a>.</p> The properties can be specified as code or name. NOTE: This feature works with <i>value</i> to find concepts having one of the specified properties with an exact value matching the <i>value</i> parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"value","in":"query","description":"A property value to restrict search results by.  NOTE: This feature works with <i>property</i> to find concepts having one of the specified properties with an exact value matching this parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"definitionSource","in":"query","description":"Comma-separated list of definition sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/definitionSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p><p><a href='/api/v1/metadata/ncim/definitionSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"definitionType","in":"query","description":"Comma-separated list of definition types to restrict search results by, e.g. 'DEFINITION,ALT_DEFINITION' for <i>terminology=ncit</i>. <p><a href='/api/v1/metadata/ncit/definitionTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymSource","in":"query","description":"Comma-separated list of synonym sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/synonymSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/synonymSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"synonymType","in":"query","description":"Comma-separated list of synonym types to restrict search results by, e.g. 'FULL_SYN'. <p><a href='/api/v1/metadata/ncit/synonymTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymTermType","in":"query","description":"Comma-separated list of synonym term type values to restrict search results by. <p><a href='/api/v1/metadata/ncit/termTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/termTypes' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"subset","in":"query","description":"Comma-separated list of subsets to restrict search results by, e.g. 'C157225'. The value '*' can also be used to return results that participate in at least one subset. This parameter is only meaningful for <i>terminology=ncit</i>","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConceptResultList"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}},"post":{"tags":["Search endpoint"],"summary":"Get concept search results for a specified terminology","description":"Use cases for search range from very simple term searches, use of paging parameters, additional filters, searches properties, roles, and associations, and so on.  To further explore the range of search options, take a look at the <a href='https://github.com/NCIEVS/evsrestapi-client-SDK' target='_blank'>Github client SDK library created for the NCI EVS Rest API</a>.","operationId":"searchSingleTerminologySparql","parameters":[{"name":"terminology","in":"path","description":"Single terminology to search, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"prefixes","in":"query","description":"Use 'true' to use queries with declared prefixes","required":false,"schema":{"type":"boolean"},"example":true},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}},{"name":"term","in":"query","description":"The term, phrase, or code to be searched, e.g. 'melanoma'","schema":{"type":"string"}},{"name":"type","in":"query","description":"The match type, one of: contains, match, startsWith, phrase, AND, OR, fuzzy.","schema":{"type":"string"},"example":"contains"},{"name":"sort","in":"query","description":"The search parameter to sort results by","schema":{"type":"string"}},{"name":"ascending","in":"query","description":"Sort ascending (if true) or descending (if false)","schema":{"type":"boolean"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","schema":{"type":"integer","format":"int32"},"example":10},{"name":"conceptStatus","in":"query","description":"Comma-separated list of concept status values to restrict search results by. <p><a href='/api/v1/metadata/ncit/conceptStatuses' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"property","in":"query","description":"Comma-separated list of properties to restrict search results by (see also <i>value</i>). e.g.<ul><li>'P106,P322' for <i>terminology=ncit</i></li><li>'COLOR,SHAPE' for <i>terminology=ncim</i></li></ul><p><a href='/api/v1/metadata/ncit/properties' target='_blank'>Click here for a list of NCI Thesaurus properties</a>.</p><p><a href='/api/v1/metadata/ncim/properties' target='_blank'>Click here for a list of NCI Metathesaurus properties</a>.</p> The properties can be specified as code or name. NOTE: This feature works with <i>value</i> to find concepts having one of the specified properties with an exact value matching the <i>value</i> parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"value","in":"query","description":"A property value to restrict search results by.  NOTE: This feature works with <i>property</i> to find concepts having one of the specified properties with an exact value matching this parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"definitionSource","in":"query","description":"Comma-separated list of definition sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/definitionSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p><p><a href='/api/v1/metadata/ncim/definitionSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"definitionType","in":"query","description":"Comma-separated list of definition types to restrict search results by, e.g. 'DEFINITION,ALT_DEFINITION' for <i>terminology=ncit</i>. <p><a href='/api/v1/metadata/ncit/definitionTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymSource","in":"query","description":"Comma-separated list of synonym sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/synonymSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/synonymSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"synonymType","in":"query","description":"Comma-separated list of synonym types to restrict search results by, e.g. 'FULL_SYN'. <p><a href='/api/v1/metadata/ncit/synonymTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymTermType","in":"query","description":"Comma-separated list of synonym term type values to restrict search results by. <p><a href='/api/v1/metadata/ncit/termTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/termTypes' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"subset","in":"query","description":"Comma-separated list of subsets to restrict search results by, e.g. 'C157225'. The value '*' can also be used to return results that participate in at least one subset. This parameter is only meaningful for <i>terminology=ncit</i>","schema":{"type":"string"}}],"requestBody":{"description":"SPARQL query that returns ?code identifying a valid code in the specified terminology. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/SPARQL.md' target='_blank'>See here for more information and examples of using SPARQL with EVSRESTAPI</a>.","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConceptResultList"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/version":{"get":{"tags":["Application version endpoint"],"summary":"Get the application version information","operationId":"getApplicationVersion","responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationVersion"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/subset/{terminology}":{"get":{"tags":["Subset endpoints"],"summary":"Get all subsets (or those specified by list parameter) for the specified terminology","operationId":"getSubsets","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return subsets for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/subset/{terminology}/{code}":{"get":{"tags":["Subset endpoints"],"summary":"Get the subset for the specified terminology and code.","operationId":"getSubset","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Subset code, e.g. 'C116978' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data tc return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/subset/{terminology}/{code}/members":{"get":{"tags":["Subset endpoints"],"summary":"Get subset members for the specified terminology and code. Concept subset endpoints will be deprecated in v2 in favor of top level subset endpoints.","operationId":"getSubsetMembers","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":10000},{"name":"code","in":"path","description":"Code for a subset concept in the specified terminology, e.g. 'C157225' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/sparql/{terminology}/prefixes":{"get":{"tags":["Search endpoint"],"summary":"Get default prefixes used by SPARQL queries","operationId":"getSparqlPrefixes","parameters":[{"name":"terminology","in":"path","description":"Single terminology to find prefixes for, e.g. 'ncit' or 'hgnc' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}":{"get":{"tags":["Metadata endpoints"],"summary":"Get some metadata (associations, properties, qualifiers, roles, term types, sources, definition types, synonym types) for the terminology overview tab in EVS-Explore","operationId":"getOverviewMetadata","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/welcomeText":{"get":{"tags":["Metadata endpoints"],"summary":"Get welcome text for the specified terminology","operationId":"getWelcomeText","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/termTypes":{"get":{"tags":["Metadata endpoints"],"summary":"Get all term types for the specified terminology","operationId":"getTermTypes","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptMinimal"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/synonymTypes":{"get":{"tags":["Metadata endpoints"],"summary":"Get all synonym types (or those specified by list parameter) for the specified terminology","operationId":"getSynonymTypes","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return synonym types for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/synonymType/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the synonym type for the specified terminology and code/name","operationId":"getSynonymType","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Synonym type code (or name), e.g.<ul><li>'P90' or 'FULL_SYN' for <i>ncit</i></li><li>'Preferred_Name' or 'Preferred name' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"417":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/synonymSources":{"get":{"tags":["Metadata endpoints"],"summary":"Get all synonym sources for the specified terminology","operationId":"getSynonymSources","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptMinimal"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/subsets":{"get":{"tags":["Metadata endpoints"],"summary":"Get all subsets (or those specified by list parameter) for the specified terminology.","description":"This endpoint will be deprecated in v2 in favor of top level subset endpoints.","operationId":"getSubsets_1","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return subsets for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/subset/{code}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the subset for the specified terminology and code.","description":"This endpoint will be deprecated in v2 in favor of top level subset endpoints.","operationId":"getSubset_1","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Subset code, e.g. 'C116978' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data tc return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/stats":{"get":{"tags":["Metadata endpoints"],"summary":"Get terminology-level load statistics for the specified terminology.","description":"Returns the stats object stored on the terminology, including load-computed counts and hierarchy statistics from the latest reindex. This is different from /metadata/{terminology}/stats/{source}, which returns source-specific overlap statistics, primarily for NCIm.","operationId":"getTerminologyStats","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'go' or 'ncit'.","required":true,"schema":{"type":"string"},"example":"go"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminologyStats"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/stats/{source}":{"get":{"tags":["Metadata endpoints"],"summary":"Get source-specific overlap statistics within the specified terminology.","description":"Returns source-level statistics for a source code, such as LNC in NCIm. This is different from /metadata/{terminology}/stats, which returns terminology-level load statistics such as concept counts and hierarchy statistics.","operationId":"getSourceStats","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.","required":true,"schema":{"type":"string"},"example":"ncim"},{"name":"source","in":"path","description":"terminology source code, e.g. 'LNC' for <i>ncim</i>.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StatisticsEntry"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/roles":{"get":{"tags":["Metadata endpoints"],"summary":"Get all roles (or those specified by list parameter) for the specified terminology","operationId":"getRoles","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return roles for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/role/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the role for the specified terminology and code/name","operationId":"getRole","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Role code (or name), e.g. 'R123' or 'Chemotherapy_Regimen_Has_Component' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/qualifiers":{"get":{"tags":["Metadata endpoints"],"summary":"Get all qualifiers (properties on properties) for the specified terminology","operationId":"getQualifiers","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return qualifiers for (or leave blank for all)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/qualifier/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the qualifier for the specified terminology and code/name","operationId":"getQualifier","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Qualifier code (or name), e.g.<ul><li>'P390' or 'go-source' for <i>ncit</i></li><li>'RG' or 'Relationship group' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/qualifier/{codeOrName}/values":{"get":{"tags":["Metadata endpoints"],"summary":"Get qualifier values for the specified terminology and code/name","operationId":"getQualifierValues","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Qualifier code (or name), e.g.<ul><li>'P390' or 'go-source' for <i>ncit</i></li><li>'RG' or 'Relationship group' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/property/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the property for the specified terminology and code/name","operationId":"getProperty","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Property code (or name), e.g. <ul><li>'P216' or 'BioCarta_ID' for <i>ncit</i></li><li>'BioCarta_ID' or ''BioCarta ID' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/property/{codeOrName}/values":{"get":{"tags":["Metadata endpoints"],"summary":"Get property values for the specified terminology and code/name","operationId":"getPropertyValues","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Property code (or name), e.g.<ul><li>'P216' or 'BioCarta_ID' for <i>ncit</i></li><li>'Semantic_Type' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/properties":{"get":{"tags":["Metadata endpoints"],"summary":"Get all properties (or those specified by list parameter) for the specified terminology","operationId":"getProperties","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return properties for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/definitionTypes":{"get":{"tags":["Metadata endpoints"],"summary":"Get all definition types (or those specified by list parameter) for the specified terminology","operationId":"getDefinitionTypes","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return definition types for (or leave blank for all).  If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/definitionType/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the definition type for the specified terminology and code/name.","operationId":"getDefinitionType","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Definition type code (or name), e.g.<ul><li>'P325' or 'DEFINITION' for <i>ncit</i></li><li>'DEFINITION' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/definitionSources":{"get":{"tags":["Metadata endpoints"],"summary":"Get all definition sources for the specified terminology","operationId":"getDefinitionSources","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptMinimal"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/conceptStatuses":{"get":{"tags":["Metadata endpoints"],"summary":"Get all concept status values for the specified terminology","operationId":"getConceptStatuses","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"},"example":"ncit"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/associations":{"get":{"tags":["Metadata endpoints"],"summary":"Get all associations (or those specified by list parameter) for the specified terminology","operationId":"getAssociations","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List of codes or labels to return associations for (or leave blank for all). If invalid values are passed, the result will simply include no entries for those invalid values.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/{terminology}/association/{codeOrName}":{"get":{"tags":["Metadata endpoints"],"summary":"Get the association for the specified terminology and code/name","operationId":"getAssociation","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrName","in":"path","description":"Association code (or name), e.g. <ul><li>'A10' or 'Has_CDRH_Parent' for <i>ncit</i></li><li>'RB' or 'has a broader relationship' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/metadata/terminologies":{"get":{"tags":["Metadata endpoints"],"summary":"Get all available terminologies","operationId":"getTerminologies","parameters":[{"name":"latest","in":"query","description":"Return terminologies with matching <i>latest</i> value. e.g. true or false","required":false,"schema":{"type":"boolean"},"example":true},{"name":"tag","in":"query","description":"Return terminologies with matching tag. e.g. 'monthly' or 'weekly' for <i>ncit</i>","required":false,"schema":{"type":"string"}},{"name":"terminology","in":"query","description":"Return entries with matching terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Terminology"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/mapset":{"get":{"tags":["Mapset endpoints"],"summary":"Get all mapsets (no terminology parameter is needed as mapsets connect codes in one terminology to another)","operationId":"getMapsets","parameters":[{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}}}}},"/api/v1/mapset/{code}":{"get":{"tags":["Mapset endpoints"],"summary":"Get the mapset for the specified code (no terminology parameter is needed as mapsets connect codes in one terminology to another)","operationId":"getMapsetByCode","parameters":[{"name":"code","in":"path","description":"Mapset code","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/mapset/{code}/maps":{"get":{"tags":["Mapset endpoints"],"summary":"Get the maps for the mapset specified by the code (no terminology parameter is needed as mapsets connect codes in one terminology to another)","operationId":"getMapsetMappingsByCode","parameters":[{"name":"code","in":"path","description":"Mapset code","required":true,"schema":{"type":"string"}},{"name":"term","in":"query","description":"The term, phrase, or code to be searched, e.g. 'melanoma'","schema":{"type":"string"}},{"name":"fromRecord","in":"query","description":"Start index of the search results","schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","schema":{"type":"integer","format":"int32"},"example":10},{"name":"sort","in":"query","description":"The search parameter to sort results by","schema":{"type":"string"}},{"name":"ascending","in":"query","description":"Sort ascending (if true) or descending (if false)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MappingResultList"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/history/{terminology}/{code}/replacements":{"get":{"tags":["History endpoints"],"summary":"Gets suggested replacements for a specified terminology and retired code. Active codes will return entries as well with an action of \"active\".","operationId":"getReplacements","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. <ul><li>'C4654' for <i>ncit</i></li><li>'C0000733' for <i>ncim</i></li></ul>.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/History"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/history/{terminology}/replacements":{"get":{"tags":["History endpoints"],"summary":"Gets suggested replacements for a specified terminology and a comma-separated list of retired codes.  Active codes will return entries as well with an action of \"active\".","operationId":"getReplacementsFromList","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"list","in":"query","description":"Comma-separated list of codes, e.g. <ul><li>'C4654,C40117' for <i>ncit</i></li><li>'C0000733,C3551741' for <i>ncim</i></li></ul>.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/History"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}":{"get":{"tags":["Concept endpoints"],"summary":"Get concepts specified by list parameter","operationId":"getConcepts","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"list","in":"query","description":"List (comma-separated) of codes to return concepts for, e.g.<ul><li>'C2291,C3224' for <i>ncit</i></li><li>'C0010137,C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}":{"get":{"tags":["Concept endpoints"],"summary":"Get the concept for the specified terminology and code","operationId":"getConcept","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g.<ul><li>'C3224' for <i>ncit</i></li><li>'C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If set to an integer (between <i>1</i> and <i>100</i>), elements of the concept should be limited to that specified number of entries. Thus a user interface can quickly retrieve initial data for a concept (even with <i>include=full</i>) and then call back for more data. An extra placeholder entry with just a <i>ct</i> field will be included to indicate the total count.","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"summary"},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/subtree":{"get":{"tags":["Concept endpoints"],"summary":"Get the entire subtree from the root node to the specified code","operationId":"getSubtree","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If set to an integer (between <i>1</i> and <i>100</i>), subtrees and siblings at each level will be limited to the specified number of entries. Thus a user interface can quickly retrieve initial data for a subtree and then call back for more data. An extra placeholder entry with just a <i>ct</i> field will be included to indicate the total count.","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyNode"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/subtree/children":{"get":{"tags":["Concept endpoints"],"summary":"Get the entire subtree from the root node to the specified code","operationId":"getSubtreeChildren","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If set to an integer (between <i>1</i> and <i>100</i>), children will be limited to the specified number of entries. Thus a user interface can quickly retrieve initial data for a subtree and then call back for more data. An extra placeholder entry with just a <i>ct</i> field will be included to indicate the total count.","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyNode"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/roles":{"get":{"tags":["Concept endpoints"],"summary":"Get roles for the specified terminology and code","operationId":"getRoles_1","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/pathsToRoot":{"get":{"tags":["Concept endpoints"],"summary":"Get paths to the hierarchy root from the specified code","operationId":"getPathsToRoot","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case.  Any value other than 'minimal' may produce very large payload results. ","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/pathsToAncestor/{ancestorCode}":{"get":{"tags":["Concept endpoints"],"summary":"Get paths from the specified code to the specified ancestor code","operationId":"getPathsToAncestor","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"ancestorCode","in":"path","description":"Ancestor code of the other specified code, e.g. 'C2991' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case.  Any value other than 'minimal' may produce very large payload results. ","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/pathsFromRoot":{"get":{"tags":["Concept endpoints"],"summary":"Get paths from the hierarchy root to the specified concept.","operationId":"getPathsFromRoot","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case.  Any value other than 'minimal' may produce very large payload results. ","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/parents":{"get":{"tags":["Concept endpoints"],"summary":"Get parent concepts for the specified terminology and code","operationId":"getParents","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. <ul><li>'C3224' for <i>ncit</i></li><li>'C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/maps":{"get":{"tags":["Concept endpoints"],"summary":"Get maps for the specified terminology and code","operationId":"getMaps","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mapping"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/inverseRoles":{"get":{"tags":["Concept endpoints"],"summary":"Get inverse roles for the specified terminology and code","operationId":"getInverseRoles","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/inverseAssociations":{"get":{"tags":["Concept endpoints"],"summary":"Get inverse associations for the specified terminology and code","operationId":"getInverseAssociations","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g.<ul><li>'C3224' for <i>ncit</i></li><li>'C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Association"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/history":{"get":{"tags":["Concept endpoints"],"summary":"Get history for the specified terminology and code","operationId":"getHistory","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i> and <i>ncim</i>.","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/disjointWith":{"get":{"tags":["Concept endpoints"],"summary":"Get \"disjoint with\" info for the specified terminology and code","operationId":"getDisjointWith","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3910' for <i>ncit</i>.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisjointWith"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/descendants":{"get":{"tags":["Concept endpoints"],"summary":"Get descendant concepts for the specified terminology and code","operationId":"getDescendants","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit''","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. 'C3224' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":50000},{"name":"maxLevel","in":"query","description":"Max level of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":10000},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/children":{"get":{"tags":["Concept endpoints"],"summary":"Get child concepts for the specified terminology and code","operationId":"getChildren","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. <ul><li>'C3224' for <i>ncit</i></li><li>'C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/{code}/associations":{"get":{"tags":["Concept endpoints"],"summary":"Get the associations for the specified terminology and code","operationId":"getAssociations_1","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\" target=\"_blank\">See here for complete list</a>)","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"code","in":"path","description":"Code in the specified terminology, e.g. <ul><li>'C3224' for <i>ncit</i></li><li>'C0025202' for <i>ncim</i></li></ul>","required":true,"schema":{"type":"string"}},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Association"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/subsetMembers/{code}":{"get":{"tags":["Concept endpoints"],"summary":"Get subset members for the specified terminology and code.","description":"This endpoint will be deprecated in v2 in favor of a top level subset member endpoint.","operationId":"getSubsetMembers_1","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":10000},{"name":"code","in":"path","description":"Code for a subset concept in the specified terminology, e.g. 'C157225' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/roots":{"get":{"tags":["Concept endpoints"],"summary":"Get root concepts for the specified terminology","operationId":"getRoots","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'.  This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"},"example":"minimal"},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Concept"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/codes":{"get":{"tags":["Concept endpoints"],"summary":"Get all codes for the specified terminology","operationId":"getAllCodesForTerminology","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/{terminology}/associations/{codeOrLabel}":{"get":{"tags":["Concept endpoints"],"summary":"Get the association entries for the specified terminology and code. Associations used to define subset membership are not resolved by this call","operationId":"getAssociationEntries","parameters":[{"name":"terminology","in":"path","description":"Terminology, e.g. 'ncit'","required":true,"schema":{"type":"string"},"example":"ncit"},{"name":"codeOrLabel","in":"path","description":"Code/label in the specified terminology, e.g. 'A5' or 'Has_Salt_Form' for <i>ncit</i>. This call is only meaningful for <i>ncit</i>.","required":true,"schema":{"type":"string"}},{"name":"fromRecord","in":"query","description":"Start index of the search results","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociationEntryResultList"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}},"/api/v1/concept/search":{"get":{"tags":["Search endpoint"],"summary":"Get concept search results","description":"Use cases for search range from very simple term searches, use of paging parameters, additional filters, searches properties, roles, and associations, and so on.  To further explore the range of search options, take a look at the <a href='https://github.com/NCIEVS/evsrestapi-client-SDK' target='_blank'>Github client SDK library created for the NCI EVS Rest API</a>.","operationId":"search","parameters":[{"name":"X-EVSRESTAPI-License-Key","in":"header","description":"Required license information for restricted terminologies. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/LICENSE.md' target='_blank'>See here for detailed information</a>.","required":false,"schema":{"type":"string"}},{"name":"terminology","in":"query","description":"Comma-separated list of terminologies to search, e.g. 'ncit' or 'ncim' (<a href=\"https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/TERMINOLOGIES.md\">See here for complete list</a>)","schema":{"type":"string"},"example":"ncit"},{"name":"term","in":"query","description":"The term, phrase, or code to be searched, e.g. 'melanoma'","schema":{"type":"string"}},{"name":"type","in":"query","description":"The match type, one of: contains, match, startsWith, phrase, AND, OR, fuzzy.","schema":{"type":"string"},"example":"contains"},{"name":"sort","in":"query","description":"The search parameter to sort results by","schema":{"type":"string"}},{"name":"ascending","in":"query","description":"Sort ascending (if true) or descending (if false)","schema":{"type":"boolean"}},{"name":"include","in":"query","description":"Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. <a href='https://github.com/NCIEVS/evsrestapi-client-SDK/blob/main/doc/INCLUDE.md' target='_blank'>See here for detailed information</a>.","schema":{"type":"string"},"example":"minimal"},{"name":"fromRecord","in":"query","description":"Start index of the search results","schema":{"type":"integer","format":"int32"},"example":0},{"name":"pageSize","in":"query","description":"Max number of results to return","schema":{"type":"integer","format":"int32"},"example":10},{"name":"conceptStatus","in":"query","description":"Comma-separated list of concept status values to restrict search results by. <p><a href='/api/v1/metadata/ncit/conceptStatuses' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"property","in":"query","description":"Comma-separated list of properties to restrict search results by (see also <i>value</i>). e.g.<ul><li>'P106,P322' for <i>terminology=ncit</i></li><li>'COLOR,SHAPE' for <i>terminology=ncim</i></li></ul><p><a href='/api/v1/metadata/ncit/properties' target='_blank'>Click here for a list of NCI Thesaurus properties</a>.</p><p><a href='/api/v1/metadata/ncim/properties' target='_blank'>Click here for a list of NCI Metathesaurus properties</a>.</p> The properties can be specified as code or name. NOTE: This feature works with <i>value</i> to find concepts having one of the specified properties with an exact value matching the <i>value</i> parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"value","in":"query","description":"A property value to restrict search results by.  NOTE: This feature works with <i>property</i> to find concepts having one of the specified properties with an exact value matching this parameter.  Using a <i>term</i> will further restrict results to those also matching the term.","schema":{"type":"string"}},{"name":"definitionSource","in":"query","description":"Comma-separated list of definition sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/definitionSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p><p><a href='/api/v1/metadata/ncim/definitionSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"definitionType","in":"query","description":"Comma-separated list of definition types to restrict search results by, e.g. 'DEFINITION,ALT_DEFINITION' for <i>terminology=ncit</i>. <p><a href='/api/v1/metadata/ncit/definitionTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymSource","in":"query","description":"Comma-separated list of synonym sources to restrict search results by. <p><a href='/api/v1/metadata/ncit/synonymSources' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/synonymSources' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"synonymType","in":"query","description":"Comma-separated list of synonym types to restrict search results by, e.g. 'FULL_SYN'. <p><a href='/api/v1/metadata/ncit/synonymTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>. This parameter is only meaningful for <i>terminology=ncit</i>.</p>","schema":{"type":"string"}},{"name":"synonymTermType","in":"query","description":"Comma-separated list of synonym term type values to restrict search results by. <p><a href='/api/v1/metadata/ncit/termTypes' target='_blank'>Click here for a list of NCI Thesaurus values</a>.</p> <p><a href='/api/v1/metadata/ncim/termTypes' target='_blank'>Click here for a list of NCI Metathesaurus values</a>.</p>","schema":{"type":"string"}},{"name":"subset","in":"query","description":"Comma-separated list of subsets to restrict search results by, e.g. 'C157225'. The value '*' can also be used to return results that participate in at least one subset. This parameter is only meaningful for <i>terminology=ncit</i>","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the requested information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConceptResultList"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}},"417":{"description":"Expectation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestException"}}}}}}}},"components":{"schemas":{"RestException":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"}},"description":"Payload for JSON error responses"},"MapResultList":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"total":{"type":"integer","description":"Total nubmer of results (if paging is not considered)","format":"int64"},"timeTaken":{"type":"integer","description":"Total time taken to compute the result","format":"int64"},"parameters":{"$ref":"#/components/schemas/SearchCriteria"},"results":{"type":"array","description":"Search criteria used to arrive at this result","items":{"type":"object","additionalProperties":{"type":"string","description":"Search criteria used to arrive at this result"},"description":"Search criteria used to arrive at this result"}}},"description":"Represents a list of objects returned from a find call"},"SearchCriteria":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"term":{"type":"string","description":"Search term, e.g. 'heart', or 'C3224'"},"type":{"type":"string","description":"The match type, one of: contains, match, startsWith, phrase, AND, OR, fuzzy"},"include":{"type":"string","description":"Include parameter value, e.g. 'minimal', 'summary', 'synonyms,properties,children'"},"sort":{"type":"string","description":"Sort field"},"ascending":{"type":"boolean","description":"Indicates whether sort is ascending (true), descending (false), or not specified (null)"},"fromRecord":{"type":"integer","description":"Start index of the search results","format":"int32"},"pageSize":{"type":"integer","description":"Max number of results to return","format":"int32"},"conceptStatus":{"type":"array","description":"Comma-separated list of concept status values to restrict search results by","items":{"type":"string","description":"Comma-separated list of concept status values to restrict search results by"}},"property":{"type":"array","description":"Comma-separated list of properties to restrict search results by","items":{"type":"string","description":"Comma-separated list of properties to restrict search results by"}},"value":{"type":"string","description":"A property value to restrict search results by"},"synonymSource":{"type":"array","description":"Comma-separated list of synonym sources to restrict search results by","items":{"type":"string","description":"Comma-separated list of synonym sources to restrict search results by"}},"synonymType":{"type":"array","description":"Comma-separated list of synonym types to restrict search results by","items":{"type":"string","description":"Comma-separated list of synonym types to restrict search results by"}},"definitionSource":{"type":"array","description":"Comma-separated list of definition sources to restrict search results by","items":{"type":"string","description":"Comma-separated list of definition sources to restrict search results by"}},"definitionType":{"type":"array","description":"Comma-separated list of definition types to restrict search results by","items":{"type":"string","description":"Comma-separated list of definition types to restrict search results by"}},"synonymTermType":{"type":"array","description":"Comma-separated list of synonym term types to restrict search results by","items":{"type":"string","description":"Comma-separated list of synonym term types to restrict search results by"}},"subset":{"type":"array","description":"Comma-separated list of subsets to restrict search results by, e.g. 'C157225'","items":{"type":"string","description":"Comma-separated list of subsets to restrict search results by, e.g. 'C157225'"}},"codeList":{"type":"array","description":"Comma-separated list of concept codes to restrict search results by, e.g. 'C157225'","items":{"type":"string","description":"Comma-separated list of concept codes to restrict search results by, e.g. 'C157225'"}},"terminology":{"type":"array","description":"Comma-separated list of terminologies to search","items":{"type":"string","description":"Comma-separated list of terminologies to search"}},"sparql":{"type":"string","description":"SPARQL query, only available as an output parameter"}},"description":"Criteria for a search or find operation"},"Association":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Relationship code"},"type":{"type":"string","description":"Relationship type"},"relatedCode":{"type":"string","description":"Related code (the code on the other side of the relationship)"},"relatedName":{"type":"string","description":"Preferred name of the related code"},"source":{"type":"string","description":"Relationship source"},"group":{"type":"string","description":"Role group number for grouping related roles"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the relationship","items":{"$ref":"#/components/schemas/Qualifier"}}},"description":"Represents a non-defining (in a logical sense) relationship between two concepts"},"Concept":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Code (unique identifier) for this meaning"},"name":{"type":"string","description":"Preferred name for the code"},"terminology":{"type":"string","description":"Terminology abbreviation, e.g. 'nci'"},"version":{"type":"string","description":"Terminology version, e.g. '23.11d'"},"level":{"type":"integer","description":"Level of depth in a hierarchy (when this object is used to represent an element in a path)","format":"int32"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"subsetLink":{"type":"string","description":"Link to download data for a subset, used when the concept represents subset metadata"},"mapsetLink":{"type":"string","description":"Metadata for downloading a mapset"},"conceptStatus":{"type":"string","description":"Status value for the concept, e.g. Retired_Concept"},"source":{"type":"string","description":"Associations from this concept to other ones"},"leaf":{"type":"boolean","description":"Indicates whether concept is a leaf node"},"active":{"type":"boolean","description":"Indicates whether the concept is active"},"defining":{"type":"boolean","description":"Indicates whether the concept is defining"},"synonyms":{"type":"array","description":"Synonyms, or all of the names for this concept, including the preferred name","items":{"$ref":"#/components/schemas/Synonym"}},"definitions":{"type":"array","description":"Text definitions","items":{"$ref":"#/components/schemas/Definition"}},"properties":{"type":"array","description":"Key/value properties","items":{"$ref":"#/components/schemas/Property"}},"children":{"type":"array","description":"Child concepts in the hierarchy","items":{"$ref":"#/components/schemas/Concept"}},"parents":{"type":"array","description":"Parent concepts in the hierarchy","items":{"$ref":"#/components/schemas/Concept"}},"descendants":{"type":"array","description":"Descendant concepts in the hierarchy","items":{"$ref":"#/components/schemas/Concept"}},"qualifiers":{"type":"array","description":"Qualifiers for use when a concept is used as a parent/child - to indicate RELA for NCIm-derived content","items":{"$ref":"#/components/schemas/Qualifier"}},"associations":{"type":"array","description":"Associations from this concept to other ones","items":{"$ref":"#/components/schemas/Association"}},"inverseAssociations":{"type":"array","description":"Associations to this concept from other ones","items":{"$ref":"#/components/schemas/Association"}},"roles":{"type":"array","description":"Roles from this concept to other ones","items":{"$ref":"#/components/schemas/Role"}},"disjointWith":{"type":"array","description":"Assertions of disjointness with respect to other concepts","items":{"$ref":"#/components/schemas/DisjointWith"}},"inverseRoles":{"type":"array","description":"Roles to this concept from other ones","items":{"$ref":"#/components/schemas/Role"}},"history":{"type":"array","description":"History records","items":{"$ref":"#/components/schemas/History"}},"maps":{"type":"array","description":"Maps from this concept to concepts in other terminologies","items":{"$ref":"#/components/schemas/Mapping"}},"paths":{"$ref":"#/components/schemas/Paths"},"extensions":{"$ref":"#/components/schemas/Extensions"}},"description":"Represents a concept in a terminology"},"ConceptMinimal":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Code (unique identifier) for this meaning"},"name":{"type":"string","description":"Preferred name for the code"},"terminology":{"type":"string","description":"Terminology abbreviation, e.g. 'nci'"},"version":{"type":"string","description":"Terminology version, e.g. '23.11d'"},"level":{"type":"integer","description":"Level of depth in a hierarchy (when this object is used to represent an element in a path)","format":"int32"}},"description":"Represents minimal information about a concept in a terminology"},"ConceptResultList":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"total":{"type":"integer","description":"Total nubmer of results (if paging is not considered)","format":"int64"},"timeTaken":{"type":"integer","description":"Total time taken to compute the result","format":"int64"},"parameters":{"$ref":"#/components/schemas/SearchCriteria"},"concepts":{"type":"array","description":"List of concepts","items":{"$ref":"#/components/schemas/Concept"}}},"description":"Represents a list of concepts returned from a search or find call"},"Definition":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"definition":{"type":"string","description":"Text definition value"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"code":{"type":"string","description":"Definition code"},"type":{"type":"string","description":"Definition type"},"source":{"type":"string","description":"Definition source"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the definition","items":{"$ref":"#/components/schemas/Qualifier"}}},"description":"Represents a text definition for a concept"},"DisjointWith":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Relationship code"},"type":{"type":"string","description":"Relationship type"},"relatedCode":{"type":"string","description":"Related code (the code on the other side of the relationship)"},"relatedName":{"type":"string","description":"Preferred name of the related code"},"source":{"type":"string","description":"Relationship source"},"group":{"type":"string","description":"Role group number for grouping related roles"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the relationship","items":{"$ref":"#/components/schemas/Qualifier"}}},"description":"Represents an assertion of disjointness between two concepts"},"Extensions":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"isDisease":{"type":"boolean"},"isDiseaseGrade":{"type":"boolean"},"isDiseaseStage":{"type":"boolean"},"isMainType":{"type":"boolean"},"isSubtype":{"type":"boolean"},"isBiomarker":{"type":"boolean"},"isReferenceGene":{"type":"boolean"},"mainMenuAncestors":{"type":"array","items":{"$ref":"#/components/schemas/Paths"}}},"description":"Generally unset, this is used for certain special cases"},"History":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Code for this history record"},"name":{"type":"string","description":"Last known preferred name for the code"},"action":{"type":"string","description":"Indicates the history action, e.g. 'merge', 'active', 'retire', 'SY', 'RB', etc."},"date":{"type":"string","description":"Date of the history record"},"replacementCode":{"type":"string","description":"Code replacing this code"},"replacementName":{"type":"string","description":"Preferred name of the code replacing this code"}},"description":"Represents a history record, generally for a retired concept"},"Mapping":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"mapsetCode":{"type":"string"},"source":{"type":"string","description":"Terminology of the source code, e.g. 'ncit'"},"sourceName":{"type":"string","description":"Preferred name of the source code"},"sourceTermType":{"type":"string","description":"Term type of the source code"},"sourceCode":{"type":"string","description":"Source code of the map (the thing being mapped 'from')"},"sourceTerminology":{"type":"string","description":"Human-readable label for the terminology of the source code, e.g. 'NCI Thesaurus'"},"sourceTerminologyVersion":{"type":"string","description":"Terminology version of the source code"},"sourceLoaded":{"type":"boolean","description":"Indicates whether the source code terminology/version is currently loaded"},"type":{"type":"string"},"rank":{"type":"string"},"group":{"type":"string"},"rule":{"type":"string"},"target":{"type":"string","description":"Terminology of the target code, e.g. 'ncit'"},"targetName":{"type":"string"},"targetTermType":{"type":"string"},"targetCode":{"type":"string","description":"Target code of the map (the thing being mapped 'to')"},"targetTerminology":{"type":"string","description":"Human-readable label for the terminology of the target code, e.g. 'NCI Thesaurus'"},"targetTerminologyVersion":{"type":"string","description":"Terminology version of the target code"},"targetLoaded":{"type":"boolean","description":"Indicates whether the target terminology/version is currently loaded"},"sortKey":{"type":"string"},"targetTermGroup":{"type":"string","writeOnly":true}},"description":"Represents a map from a concept to concepts in other terminologies"},"Path":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"direction":{"type":"integer","description":"Direction of the map (1 means node-to-root, -1 means root-to-node)","format":"int32"},"concepts":{"type":"array","description":"Concepts on the path","items":{"$ref":"#/components/schemas/ConceptMinimal"}}},"description":"Represents a path (or partial path) in a hierarchy"},"Paths":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"paths":{"type":"array","description":"List of paths","items":{"$ref":"#/components/schemas/Path"}}},"description":"Represents a list of paths"},"Property":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string"},"type":{"type":"string","description":"Property type"},"value":{"type":"string","description":"Property value"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the property","items":{"$ref":"#/components/schemas/Qualifier"}},"source":{"type":"string","description":"Property source"}},"description":"Represents a type/value property on a concept"},"Qualifier":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Qualifier code"},"type":{"type":"string","description":"Qualifier type"},"value":{"type":"string","description":"Qualifier value"}},"description":"Represents a type/value qualifier on a concept element"},"Role":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Relationship code"},"type":{"type":"string","description":"Relationship type"},"relatedCode":{"type":"string","description":"Related code (the code on the other side of the relationship)"},"relatedName":{"type":"string","description":"Preferred name of the related code"},"source":{"type":"string","description":"Relationship source"},"group":{"type":"string","description":"Role group number for grouping related roles"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the relationship","items":{"$ref":"#/components/schemas/Qualifier"}}},"description":"Represents a (logically) defining relationship between two concepts"},"Synonym":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"name":{"type":"string","description":"Name for a concept"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"termType":{"type":"string","description":"Synonym term type"},"type":{"type":"string","description":"Synonym type"},"typeCode":{"type":"string","description":"Synonym Type code"},"source":{"type":"string","description":"Synonym source"},"code":{"type":"string","description":"Code of the synonym, used in particular for Metathesaurus data where the source of the synonym is not the terminology itself"},"subSource":{"type":"string","description":"Synonym sub-source"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the synonym","items":{"$ref":"#/components/schemas/Qualifier"}},"active":{"type":"boolean","description":"Indicates whether the synonym is active"}},"description":"Represents one of the (potentially many) names for a concept"},"ApplicationVersion":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"}}},"CodeCount":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"}},"description":"Statistics for a code/count pair"},"HierarchyStats":{"type":"object","properties":{"applicable":{"type":"boolean"},"codeCount":{"type":"integer","format":"int64"},"treePositionCount":{"type":"integer","format":"int64"},"rootCount":{"type":"integer","format":"int64"},"minPaths":{"$ref":"#/components/schemas/CodeCount"},"maxPaths":{"$ref":"#/components/schemas/CodeCount"},"maxChildren":{"$ref":"#/components/schemas/CodeCount"},"maxParents":{"$ref":"#/components/schemas/CodeCount"}},"description":"Hierarchy statistics"},"TerminologyStats":{"type":"object","properties":{"terminology":{"type":"string"},"version":{"type":"string"},"conceptCount":{"type":"integer","format":"int64"},"codeCount":{"type":"integer","format":"int64"},"activeConceptCount":{"type":"integer","format":"int64"},"inactiveConceptCount":{"type":"integer","format":"int64"},"synonymCount":{"type":"integer","format":"int64"},"definitionCount":{"type":"integer","format":"int64"},"propertyCount":{"type":"integer","format":"int64"},"parentReferenceCount":{"type":"integer","format":"int64"},"childReferenceCount":{"type":"integer","format":"int64"},"associationCount":{"type":"integer","format":"int64"},"inverseAssociationCount":{"type":"integer","format":"int64"},"roleCount":{"type":"integer","format":"int64"},"inverseRoleCount":{"type":"integer","format":"int64"},"mapCount":{"type":"integer","format":"int64"},"hierarchy":{"$ref":"#/components/schemas/HierarchyStats"}},"description":"Statistics computed while processing a terminology load"},"StatisticsEntry":{"type":"object","properties":{"code":{"type":"string","description":"Code for what this statistic is measuring"},"key":{"type":"string","description":"Key defining an additional element to the statistic"},"value":{"type":"string","description":"Value of the statistic"}},"description":"Represents an entry in a statistics table"},"Terminology":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"terminology":{"type":"string","description":"Terminology abbreviation, e.g. 'ncit'"},"version":{"type":"string","description":"Terminology version, e.g. '23.11d'"},"date":{"type":"string","description":"Terminology publication/release date"},"name":{"type":"string","description":"Terminology name"},"description":{"type":"string","description":"Terminology description"},"graph":{"type":"string","description":"Name of the RDF triplestore graph if this data is backed by a triplestore"},"terminologyVersion":{"type":"string","description":"Underscore-separated value for terminology and version used by the API to precisely pinpoint a particular version, e.g. 'ncit_23.11d'"},"latest":{"type":"boolean","description":"Indicates whether this is the latest version"},"tags":{"type":"object","additionalProperties":{"type":"string","description":"Additional terminology tags"},"description":"Additional terminology tags"},"indexName":{"type":"string","description":"for internal use"},"objectIndexName":{"type":"string","description":"for internal use"},"metadata":{"$ref":"#/components/schemas/TerminologyMetadata"},"stats":{"$ref":"#/components/schemas/TerminologyStats"},"sparqlFlag":{"type":"boolean","description":"Indicates whether the terminology can be used with SPARQL"}},"description":"Represents a terminology loaded into the API"},"TerminologyMetadata":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"uiLabel":{"type":"string","description":"Human-readable name for the terminology to use in a UI label"},"maxVersions":{"type":"integer","description":"Max number of versions to keep at the same time","format":"int32"},"loader":{"type":"string","description":"Label for the loader used to populate this data"},"conceptStatuses":{"type":"array","description":"Concept status values used by the terminology","items":{"type":"string","description":"Concept status values used by the terminology"}},"excludedProperties":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"retiredStatusValue":{"type":"string","description":"Concept status value for retired concepts"},"detailsColumns":{"type":"object","additionalProperties":{"type":"boolean","description":"Metadata for displaying concept"},"description":"Metadata for displaying concept"},"hierarchy":{"type":"boolean","description":"Indicates whether or not the terminology has a hierarchy"},"hierarchyRoles":{"uniqueItems":true,"type":"array","description":"Indicates role codes that are reinterpreted as parent/child","items":{"type":"string","description":"Indicates role codes that are reinterpreted as parent/child"}},"history":{"type":"boolean","description":"Indicates whether or not the terminology has history records"},"sourceCt":{"type":"integer","description":"Count of included sources","format":"int32"},"subsetLink":{"type":"string","description":"Metadata for downloading a subset"},"licenseText":{"type":"string","description":"License text for the UI"},"metaConceptField":{"type":"string","description":"Metadata for concept display"},"codeLabel":{"type":"string","description":"Metadata for concept display"},"welcomeText":{"type":"string","description":"Metadata for landing page welcome text"},"indexRuntime":{"type":"integer","format":"int64"},"historyVersion":{"type":"string"},"duplicateCodes":{"type":"boolean"},"synonymTermGroup":{"type":"string","writeOnly":true},"termGroups":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"preferredTermGroups":{"type":"array","writeOnly":true,"items":{"type":"string"}}},"description":"Represents additional terminology metadata"},"MappingResultList":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"total":{"type":"integer","description":"Total nubmer of results (if paging is not considered)","format":"int64"},"timeTaken":{"type":"integer","description":"Total time taken to compute the result","format":"int64"},"parameters":{"$ref":"#/components/schemas/SearchCriteria"},"maps":{"type":"array","description":"List of maps","items":{"$ref":"#/components/schemas/Mapping"}}},"description":"Represents a list of maps returned from a search or find call"},"HierarchyNode":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Code of the hierarchy node"},"label":{"type":"string","description":"Code label for the hierarchy node"},"level":{"type":"integer","description":"Indicates level of depth in the (respective) hierarchy","format":"int32"},"leaf":{"type":"boolean","description":"Indicates whether the code has children"},"expanded":{"type":"boolean","description":"Indicates whether the node has been expanded"},"children":{"type":"array","description":"Child nodes","items":{"$ref":"#/components/schemas/HierarchyNode"}}},"description":"Represents a node in a subtree rendering of the hierarchy"},"AssociationEntry":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"code":{"type":"string","description":"Code on the 'from' side of the association"},"type":{"type":"string","description":"Relationship type"},"relatedCode":{"type":"string","description":"Code on the 'to' side of the association"},"relatedName":{"type":"string","description":"Preferred name of the related code"},"source":{"type":"string","description":"Relationship source"},"group":{"type":"string","description":"Role group number for grouping related roles"},"highlight":{"type":"string","description":"Used by search calls to provide information for highlighting a view of results"},"qualifiers":{"type":"array","description":"Type/value qualifiers on the relationship","items":{"$ref":"#/components/schemas/Qualifier"}},"terminology":{"type":"string","description":"Terminology abbreviation, e.g. 'nci'"},"version":{"type":"string","description":"Terminology version, e.g. '23.11d'"},"association":{"type":"string","description":"Type of relationship between code and related code"},"name":{"type":"string","description":"Preferred name of the code"}},"description":"Represents an entry in a table of associations between two concepts"},"AssociationEntryResultList":{"type":"object","properties":{"uri":{"type":"string","description":"URI for this element in an rdf-based source file"},"ct":{"type":"integer","description":"Used to indicate the total amount of data in cases where a limit is being applied","format":"int32"},"total":{"type":"integer","description":"Total nubmer of results (if paging is not considered)","format":"int64"},"timeTaken":{"type":"integer","description":"Total time taken to compute the result","format":"int64"},"parameters":{"$ref":"#/components/schemas/SearchCriteria"},"associationEntries":{"type":"array","items":{"$ref":"#/components/schemas/AssociationEntry"}}}}}}}