--- swagger: "2.0" info: description: "API for the Shared Semantic Infrastructure Service" version: "1.0" title: "SSIS API" host: "cadsrapi.cancer.gov" basePath: "/si-api/v1" tags: - name: "Database" description: "" - name: "Data Elements" description: "" - name: "Find Path" description: "" - name: "Resources" description: "" - name: "Terminologies" description: "" - name: "Search" description: "" schemes: - "https" consumes: - "application/json" produces: - "application/json" paths: /search/annotations: get: tags: - "Search" summary: "Search For Concept Over All Annotations - Q20" description: "\r\nSearch\ \ for vocabulary concept with over all annotations in NCIt." operationId: "searchannotations_GET_1" parameters: - name: "search_term" in: "query" description: "The search term\r\nExample : gender" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchannotations_GET_response" "401": description: "Access Denied" /search/synonyms: get: tags: - "Search" summary: "Search For Concept With Over All Synonyms - Q21" description: "\r\n\ Search for vocabulary concept with over all synonyms in NCIt." operationId: "searchsynonyms_GET_2" parameters: - name: "search_term" in: "query" description: "The search term\r\nExample : gender" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchsynonyms_GET_response" "401": description: "Access Denied" /search/data_element_definition: get: tags: - "Search" summary: "Search For Common Data Elements With Text Over The Definition\ \ - Q22" description: "\r\nSearch for common data elements with text over the definition." operationId: "searchdata_element_definition_GET_3" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample : caDSR" required: true type: "string" - name: "text" in: "query" description: "The search term\r\nexample: gender" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchdata_element_definition_GET_response" "401": description: "Access Denied" /search/common_data_elements: get: tags: - "Search" summary: "Search For Common Data Elements Over Concept Labels\ \ - Q23" description: "\r\nSearch for common data elements with a text query over the concept\ \ labels of concepts in the object class between NCIt and caDSR." operationId: "searchcommon_data_elements_GET_4" parameters: - name: "search_term" in: "query" description: "The search term\r\nexample: gender" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchcommon_data_elements_GET_response" "401": description: "Access Denied" /search/common_parent: get: tags: - "Search" summary: "Find Common Parent - Q24" description: "\r\nSearch for common data\ \ elements with a text query over the concept labels of concepts in the object\ \ class between NCIt and caDSR." operationId: "searchcommon_parent_GET_5" parameters: - name: "input_ccode" in: "query" description: "Input CCode\r\nexample: C2985" required: true type: "string" - name: "comparator_ccode" in: "query" description: "Comparator CCode\r\nexample: C27551" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchcommon_parent_GET_response" "401": description: "Access Denied" /search/cde_path: get: tags: - "Search" summary: "Find Cde Path - Q25A" description: "\r\nFind CDE path - limit 100 rows" operationId: "searchcde_path_GET_6" parameters: - name: "resource_name" in: "query" description: "A resource within srro\r\navailable values : srro:GO, srro:NCIt,\ \ srro:SRRO, srro:caDSR" required: true type: "string" - name: "cde_public_id" in: "query" description: "CDE Public ID\r\nexample : 62" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchcde_path_GET_response" "401": description: "Access Denied" /search/alt/cde_path: get: tags: - "Search" summary: "Find Cde Path (Alternative) - Q25B" description: "\r\nFind CDE path\ \ - limit 100 rows" operationId: "searchaltcde_path_GET_7" parameters: - name: "cde_main_concept_code" in: "query" description: "CDE Main Concept Code\r\nexample: C3242" required: true type: "string" - name: "target_oc_concept_code" in: "query" description: "Target OC Concept Code\r\nexample = C188021" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchaltcde_path_GET_response" "401": description: "Access Denied" /search/path_between_two_concepts: get: tags: - "Search" summary: "Find Path Between Two Concepts - Q26" description: "\r\nFind path between\ \ two concepts - limit 100 rows" operationId: "searchpath_between_two_concepts_GET_8" parameters: - name: "input_ccode" in: "query" description: "Input CCode\r\nexample: C298" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchpath_between_two_concepts_GET_response" "401": description: "Access Denied" /search/meta_crosswalk: get: tags: - "Search" summary: "Get Meta Crosswalk - Q27" description: "\r\nThe Metathesaurus contains\ \ mappings from the Meta Concept to other standard terminologies. It can be\ \ searched using a concept from an external terminology and then, and if mapped\ \ other terminologies, you can retrieve the mapped concept." operationId: "searchmeta_crosswalk_GET_9" parameters: - name: "input_code" in: "query" description: "Input Code\r\nexample: MTHU002975" required: true type: "string" - name: "input_source" in: "query" description: "Input Source\r\nexample: LNC" required: true type: "string" - name: "mapped_terminology_source" in: "query" description: "Mapped Terminology Source\r\nexample: NCI" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/searchmeta_crosswalk_GET_response" "401": description: "Access Denied" /resources/types: get: tags: - "Resources" summary: "All Items Of A Given Resource Type - Q1 And Q2" description: "\r\n\ Lists all items of a given resource type in the srro service." operationId: "resourcestypes_GET_10" parameters: - name: "resource_type" in: "query" description: "The type of resource to get names for\r\nexample: sd:NamedGraph\ \ | srro:ResourceIntent | srro:ServiceRdfResource" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcestypes_GET_response" "401": description: "Access Denied" /resources/of_intent: get: tags: - "Resources" summary: "Resources With A Given Intent - Q3" description: "\r\nLists resources\ \ with a given intent." operationId: "resourcesof_intent_GET_11" parameters: - name: "intent" in: "query" description: "Intent/purpose to get resources of\r\nexample: srro:metadata\ \ | srro:schema | srro:terminology" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcesof_intent_GET_response" "401": description: "Access Denied" /resources/graph_name: get: tags: - "Resources" summary: "Graph name of a resource - Q4" description: "\r\nGet the graph name\ \ of a resource." operationId: "resourcesgraph_name_GET_12" parameters: - name: "resource_name" in: "query" description: "A resource within srro\r\nexample: srro:GO | srro:NCIt | srro:SRRO\ \ | srro:caDSR\r\n" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcesgraph_name_GET_response" "401": description: "Access Denied" /resources/graph_properties: get: tags: - "Resources" summary: "Properties of a graph - Q5" description: "\r\nGet all the properties\ \ in a resource graph" operationId: "resourcesgraph_properties_GET_13" parameters: - name: "graph_name" in: "query" description: "The name of the graph to get properties for. \r\nexample: http://ncicb.nci.nih.gov/xml/owl/EVS/ThesaurusInf.rdf" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcesgraph_properties_GET_response" "401": description: "Access Denied" /resources/common_properties: get: tags: - "Resources" summary: "Common Properties Of A Resource - Q6" description: "\r\nList common\ \ properties of a resource." operationId: "resourcescommon_properties_GET_14" parameters: - name: "resource" in: "query" description: "A resource within srro\r\nAvailable values : srro:GO, srro:NCIt,\ \ srro:SRRO, srro:caDSR" required: true type: "string" - name: "parent_class" in: "query" description: "The parent class of the common properties to list\r\nexample:\ \ srro:ResourceEntityDescription" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcescommon_properties_GET_response" "401": description: "Access Denied" /resources/common_property: get: tags: - "Resources" summary: "Specific common property of a resource - Q7" description: "\r\nGet\ \ a specific common property of a resource." operationId: "resourcescommon_property_GET_15" parameters: - name: "resource_name" in: "query" description: "A resource within srro\r\nAvailable values : srro:GO, srro:NCIt,\ \ srro:SRRO, srro:caDSR" required: true type: "string" - name: "property_name" in: "query" description: "A common property\r\nAvailable values : srro:Definition, srro:PreferredTerm,\ \ srro:Term, srro:Identifier" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/resourcescommon_property_GET_response" "401": description: "Access Denied" /data_elements/object_classes: get: tags: - "Data Elements" summary: "Object Class Concepts Of Data Element - Q16" description: "Get object\ \ class concepts for a data element." operationId: "data_elementsobject_classes_GET_16" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" - name: "term_id" in: "query" description: "Term ID\r\nexample: 3101150" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementsobject_classes_GET_response" "401": description: "Access Denied" /data_elements/permissible_values: get: tags: - "Data Elements" summary: "Permissible values of data element - Q17" description: "\r\nGet permissible\ \ values of a data element." operationId: "data_elementspermissible_values_GET_17" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" - name: "term_id" in: "query" description: "Term ID\r\nexample: 3103479" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementspermissible_values_GET_response" "401": description: "Access Denied" /data_elements/with_specific_object_class: get: tags: - "Data Elements" summary: "Data Elements That Have A Specific Primary (Main) Object\ \ Class Concept - Q18" description: "\r\nList data elements that have a specific object class.\ \ Limited to 1000 results." operationId: "data_elementswith_specific_object_class_GET_18" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" - name: "concept_id" in: "query" description: "The concept ID\r\nexample: C25190" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementswith_specific_object_class_GET_response" "401": description: "Access Denied" /data_elements/object_class_peers: get: tags: - "Data Elements" summary: "Given A Data Element, Find Other Data Elements That\ \ Have The Same Object Class - Q18A" description: "\r\nGiven a data element, find other data\ \ elements that have the same Object Class. Same object class means the other\ \ data elements and the given data element have same main and minor concepts." operationId: "data_elementsobject_class_peers_GET_19" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "given_id" in: "query" description: "he Given data element ID\r\nexample: 3101150" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementsobject_class_peers_GET_response" "401": description: "Access Denied" /data_elements/main_concept_peers: get: tags: - "Data Elements" summary: "Given A Data Element, Find Other Cdes That Have The\ \ Same Main Concept Object Class - Q18B" description: "\r\nGiven a data element, find other\ \ data elements that have the same Main Concept Object Class. Limited to 100." operationId: "data_elementsmain_concept_peers_GET_20" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "given_id" in: "query" description: "The Given data element ID\r\nexample: 3101150" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementsmain_concept_peers_GET_response" "401": description: "Access Denied" /data_elements/with_concept_id: get: tags: - "Data Elements" summary: "Data Elements With A Specific Concept Id - Q19" description: "\r\n\ List data elements that have a specific Data Element Concept. Limited to 100\ \ results." operationId: "data_elementswith_concept_id_GET_21" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample: http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nexample: caDSR" required: true type: "string" - name: "dec_pub_id" in: "query" description: "DEC public ID\r\nexample: 7574294" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/data_elementswith_concept_id_GET_response" "401": description: "Access Denied" /terminologies/vocabulary_concept_common_properties: get: tags: - "Terminologies" summary: "Vocabulary concept common properties - Q8" description: "\r\nGet a\ \ vocabulary concept by its identifier and return its common properties/values.\ \ This utilizes SRRO to find the appropriate property for a specified graph." operationId: "terminologiesvocabulary_concept_common_properties_GET_22" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nExample : http://www.geneontology.org/GO" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nExample : GO" required: true type: "string" - name: "term_id" in: "query" description: "The term ID\r\nExample : GO:0000070" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesvocabulary_concept_common_properties_GET_response" "401": description: "Access Denied" /terminologies/vocabulary_concept_properties: get: tags: - "Terminologies" summary: "All vocabulary concept properties - Q9" description: "\r\nGet a vocabulary\ \ concept by its identifier and return all its properties/values. This utilizes\ \ SRRO to find the appropriate property for a specified graph." operationId: "terminologiesvocabulary_concept_properties_GET_23" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nExample: http://ncicb.nci.nih.gov/xml/owl/EVS/ThesaurusInf.rdf\r\ \n\r\n" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nExample: NCIt\r\n" required: true type: "string" - name: "term_id" in: "query" description: "The term ID\r\nExample: C113525" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesvocabulary_concept_properties_GET_response" "401": description: "Access Denied" /terminologies/vocabulary_concepts_related_to_definition: get: tags: - "Terminologies" summary: "Vocabulary concepts related to a definition - Q10" description: "\r\ \nGet vocabulary concepts related to a focus concept (all roles and immediate\ \ superclasses - i.e. the definition) from NCIt. This utilizes SRRO to find\ \ the appropriate property for a specified graph." operationId: "terminologiesvocabulary_concepts_related_to_definition_GET_24" parameters: - name: "term_id" in: "query" description: "The term ID\r\nexample : C113525" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesvocabulary_concepts_related_to_definition_GET_response" "401": description: "Access Denied" /terminologies/subclasses_of_concept: get: tags: - "Terminologies" summary: "All Subclasses Of A Concept - Q11 And Q12" description: "\r\nGet all\ \ subclasses of a concept by its identifier. This utilizes SRRO to find the\ \ appropriate property for a specified graph. Note that all subclasses should\ \ include its self." operationId: "terminologiessubclasses_of_concept_GET_25" parameters: - name: "term_id" in: "query" description: "The term ID\r\nexample: C20027" required: true type: "string" - name: "use_transitive_closure" in: "query" description: "Use transitive closure of the class\r\nexample (boolean): false" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiessubclasses_of_concept_GET_response" "401": description: "Access Denied" /terminologies/is_class_in_transitive_closure_of_another_class: get: tags: - "Terminologies" summary: "Determine If Class Is Subclass Of Another Class - Q13" description: "\r\ \nCheck if a class is in the transitive closure of another class. term_id_1\ \ is the class to check, term_id_2 is the class to check against. This may\ \ have to be rerun twice by swapping what values are used for 'term_id_1'\ \ and 'term_id_2' in case nothing is returned. This utilizes SRRO to find\ \ the appropriate property for a specified graph." operationId: "terminologiesis_class_in_transitive_closure_of_another_class_GET_26" parameters: - name: "term_id_to_check" in: "query" description: "The term ID to check, example='C20027'" required: true type: "string" - name: "term_id_to_check_against" in: "query" description: "The term ID to check against, example='C113225'" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesis_class_in_transitive_closure_of_another_class_GET_response" "401": description: "Access Denied" /terminologies/data_element_common_properties: get: tags: - "Terminologies" summary: "Data Element Common Properties - Q14" description: "\r\nGet a data\ \ element by its identifier and return its common properties/values. This\ \ utilizes SRRO to get find the identifier that corresponds to the specified\ \ graph." operationId: "terminologiesdata_element_common_properties_GET_27" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nExample : http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nExample : caDSR" required: true type: "string" - name: "term_id" in: "query" description: "The term ID\r\nExample : 2936520" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesdata_element_common_properties_GET_response" "401": description: "Access Denied" /terminologies/data_element: get: tags: - "Terminologies" summary: "Data Element By Identifier - Q15" description: "\r\nGet a data element\ \ by its identifier. The identifier is the unique string within a graph that\ \ corresponds to a specific common data element This utilizes SRRO to find\ \ which identifier is specified for a specific graph." operationId: "terminologiesdata_element_GET_28" parameters: - name: "graph_name" in: "query" description: "The graph name\r\nexample : http://cbiit.nci.nih.gov/caDSR" required: true type: "string" - name: "resource_name" in: "query" description: "The resource name\r\nExample : caDSR" required: true type: "string" - name: "term_id" in: "query" description: "The term ID\r\nExample : 2936520" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/terminologiesdata_element_GET_response" "401": description: "Access Denied" /database/graph_names: get: tags: - "Database" summary: "Graph Names" description: "List all graph names in the database backing\ \ the SSIS API." operationId: "databasegraph_names_GET_29" parameters: - name: "limit" in: "query" description: "The maximum amount of results to query for.\r\nexample: 100" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/databasegraph_names_GET_response" "401": description: "Access Denied" /find_path/path_between_concepts: get: tags: - "Find Path" summary: "Path Between Two Concepts - Q13A" description: "\r\nFinds the path\ \ between two concepts within NCIt." operationId: "find_pathpath_between_concepts_GET_30" parameters: - name: "first_term_id" in: "query" description: "The first term ID\r\nexample: ncit:C20510" required: true type: "string" - name: "second_term_id" in: "query" description: "The second term ID\r\nexample: ncit:C20027" required: true type: "string" responses: "200": description: "OK" schema: $ref: "#/definitions/find_pathpath_between_concepts_GET_response" "401": description: "Access Denied" definitions: graphProperties: required: - "property" - "property_label" properties: property: type: "string" property_label: type: "string" common_properties: required: - "common_property" - "resource_property" properties: common_property: type: "string" resource_property: type: "string" searchannotations_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/annotations" apiResponse: $ref: "#/definitions/apiResponse" data_elementsmain_concept_peers_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/main_concept_peers" apiResponse: $ref: "#/definitions/apiResponse" find_pathpath_between_concepts_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/path_between_concepts" apiResponse: $ref: "#/definitions/apiResponse" terminologiesdata_element_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/data_element" apiResponse: $ref: "#/definitions/apiResponse" resourcesgraph_name_GET_response: required: - "apiResponse" - "name" properties: name: type: "string" apiResponse: $ref: "#/definitions/apiResponse" data_elementswith_concept_id_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/object_class" apiResponse: $ref: "#/definitions/apiResponse" databasegraph_names_GET_response: required: - "apiResponse" - "graph" properties: graph: type: "array" items: type: "string" apiResponse: $ref: "#/definitions/apiResponse" terminologiesvocabulary_concepts_related_to_definition_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/vocabulary_concepts_related_to_definition" apiResponse: $ref: "#/definitions/apiResponse" terminologiesdata_element_common_properties_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/vocabulary_concept_common_properties" apiResponse: $ref: "#/definitions/apiResponse" common_data_elements: required: - "concept_label" - "entity" - "identifier" - "label" properties: entity: type: "string" identifier: type: "string" label: type: "string" concept_label: type: "string" searchaltcde_path_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/cde_path2" apiResponse: $ref: "#/definitions/apiResponse" resourcesgraph_properties_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/graphProperties" apiResponse: $ref: "#/definitions/apiResponse" vocabulary_concept_common_properties: required: - "definitions" - "entity" - "identifier" - "preferred_term" - "terms" properties: entity: type: "string" identifier: type: "string" preferred_term: type: "string" terms: type: "string" definitions: type: "string" vocabulary_concept_properties: required: - "all_props" - "entity" properties: entity: type: "string" all_props: type: "string" data_elementsobject_classes_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/object_classes" apiResponse: $ref: "#/definitions/apiResponse" data_element: required: - "all_props" - "entity" properties: entity: type: "string" all_props: type: "string" permissible_values: required: - "concept" - "entity" - "identifier" - "order" - "preferred_term" - "pv_text" - "pv_value" properties: entity: type: "string" identifier: type: "string" preferred_term: type: "string" pv_value: type: "string" pv_text: type: "string" concept: type: "string" order: type: "string" main_concept_peers: required: - "data_element" - "preferred_term" - "public_id" properties: data_element: type: "string" public_id: type: "string" preferred_term: type: "string" cde_path: required: - "cde_main_concept_code" - "cde_main_concept_name" - "cde_preferred_term" - "cde_public_id" properties: cde_public_id: type: "string" cde_preferred_term: type: "string" cde_main_concept_code: type: "string" cde_main_concept_name: type: "string" data_elementspermissible_values_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/permissible_values" apiResponse: $ref: "#/definitions/apiResponse" vocabulary_concepts_related_to_definition: required: - "entity" - "property" - "property_name" - "value" - "value_label" properties: entity: type: "string" property: type: "string" property_name: type: "string" value: type: "string" value_label: type: "string" object_class: required: - "entity" - "identifier" - "preferred_term" properties: entity: type: "string" identifier: type: "string" preferred_term: type: "string" terminologiesvocabulary_concept_common_properties_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/vocabulary_concept_common_properties" apiResponse: $ref: "#/definitions/apiResponse" path_between_concepts: required: - "label" - "url" properties: url: type: "string" label: type: "string" searchcommon_data_elements_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/common_data_elements" apiResponse: $ref: "#/definitions/apiResponse" searchdata_element_definition_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/annotations" apiResponse: $ref: "#/definitions/apiResponse" common_parent: required: - "comparatorCCode" - "comparatorLabel" - "inputAndRecommendedOC" - "inputCCode" - "inputLabel" - "pathType" - "stepEndCCode" - "stepEndLabel" - "stepFrom" - "stepStartCCode" - "stepStartLabel" - "stepTo" properties: pathType: type: "string" inputAndRecommendedOC: type: "string" inputCCode: type: "string" inputLabel: type: "string" comparatorCCode: type: "string" comparatorLabel: type: "string" stepFrom: type: "string" stepTo: type: "string" stepStartCCode: type: "string" stepStartLabel: type: "string" stepEndCCode: type: "string" stepEndLabel: type: "string" path_between_two_concepts: required: - "conceptCCode" - "conceptLabel" - "inputCCode" - "inputLabel" - "parentCCode" - "parentLabel" properties: inputCCode: type: "string" inputLabel: type: "string" conceptLabel: type: "string" conceptCCode: type: "string" parentLabel: type: "string" parentCCode: type: "string" resourcescommon_property_GET_response: required: - "apiResponse" - "specific_property" properties: specific_property: type: "string" apiResponse: $ref: "#/definitions/apiResponse" synonyms: required: - "entity" - "identifier" - "label" - "term" properties: entity: type: "string" identifier: type: "string" label: type: "string" term: type: "string" resourcestypes_GET_response: required: - "apiResponse" - "name" properties: name: type: "array" items: type: "string" apiResponse: $ref: "#/definitions/apiResponse" data_elementswith_specific_object_class_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/object_class" apiResponse: $ref: "#/definitions/apiResponse" terminologiessubclasses_of_concept_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/subclasses_of_concept" apiResponse: $ref: "#/definitions/apiResponse" terminologiesvocabulary_concept_properties_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/vocabulary_concept_properties" apiResponse: $ref: "#/definitions/apiResponse" searchpath_between_two_concepts_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/path_between_two_concepts" apiResponse: $ref: "#/definitions/apiResponse" searchsynonyms_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/synonyms" apiResponse: $ref: "#/definitions/apiResponse" searchcde_path_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/cde_path" apiResponse: $ref: "#/definitions/apiResponse" resourcescommon_properties_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/common_properties" apiResponse: $ref: "#/definitions/apiResponse" searchmeta_crosswalk_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/meta_crosswalk" apiResponse: $ref: "#/definitions/apiResponse" object_classes: required: - "concept" - "entity" - "identifier" - "order" - "preferred_term" properties: entity: type: "string" identifier: type: "string" preferred_term: type: "string" concept: type: "string" order: type: "string" annotations: required: - "entity" - "identifier" - "label" - "property" - "value" properties: entity: type: "string" identifier: type: "string" label: type: "string" property: type: "string" value: type: "string" meta_crosswalk: required: - "Input_code" - "Input_code_name" - "Input_source" - "Mapped_Terminology_Code" - "Mapped_Terminology_Source" - "Mapped_Terminology_Term" - "NCIm_ID" properties: Input_code: type: "string" Input_source: type: "string" Input_code_name: type: "string" NCIm_ID: type: "string" Mapped_Terminology_Code: type: "string" Mapped_Terminology_Source: type: "string" Mapped_Terminology_Term: type: "string" cde_path2: required: - "cde_main_concept_code" - "cde_main_concept_name" - "cde_oc_is_a_subclass_of_rec_oc" - "target_oc_concept_code" - "target_oc_concept_name" properties: cde_main_concept_code: type: "string" cde_main_concept_name: type: "string" target_oc_concept_code: type: "string" target_oc_concept_name: type: "string" cde_oc_is_a_subclass_of_rec_oc: type: "string" terminologiesis_class_in_transitive_closure_of_another_class_GET_response: required: - "apiResponse" - "result" properties: result: type: "boolean" apiResponse: $ref: "#/definitions/apiResponse" resourcesof_intent_GET_response: required: - "apiResponse" - "name" properties: name: type: "string" apiResponse: $ref: "#/definitions/apiResponse" apiResponse: required: - "type" properties: type: type: "string" description: "S Success, E Error, W Warning, I Info, A Abort" message: type: "string" description: "Message text" service: type: "string" description: "service that errorred" time: type: "string" description: "Date and time of error" ssnid: type: "string" description: "session id" callStack: type: "array" items: $ref: "#/definitions/callstackItem" subclasses_of_concept: required: - "subClass" - "subClassId" - "subClassLabel" properties: subClass: type: "string" subClassLabel: type: "string" subClassId: type: "string" searchcommon_parent_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/common_parent" apiResponse: $ref: "#/definitions/apiResponse" data_elementsobject_class_peers_GET_response: required: - "apiResponse" - "results" properties: results: type: "array" items: $ref: "#/definitions/object_class" apiResponse: $ref: "#/definitions/apiResponse" callstackItem: required: - "flowStep" - "service" properties: service: type: "string" flowStep: type: "string" description: "call stack. To be used by support." externalDocs: description: "NCI Cancer for Biomedical Informatics & Information Technology - Website" url: "https://datascience.cancer.gov/about/contact"