{"openapi":"3.0.1","info":{"title":"Content Service","description":"REST API for Reactome content","termsOfService":"/license","contact":{"name":"Reactome","url":"https://reactome.org","email":"help@reactome.org"},"license":{"name":"Creative Commons Attribution 4.0 International (CC BY 4.0) License","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"1.2"},"servers":[{"url":"/ContentService"}],"tags":[{"name":"events","description":"Reactome Data: Queries related to events"},{"name":"entities","description":"Reactome Data: PhysicalEntity queries"},{"name":"mapping","description":"Reactome Data: Mapping related queries"},{"name":"species","description":"Reactome Data: Species related queries"},{"name":"participants","description":"Reactome Data: Queries related to participants"},{"name":"schema","description":"Reactome Data: Schema class queries"},{"name":"discover","description":"Reactome Data: Search engines discovery schema"},{"name":"orthology","description":"Reactome Data: Orthology related queries"},{"name":"person","description":"Reactome Data: Person queries"},{"name":"interactors","description":"Molecule interactors"},{"name":"references","description":"Reactome xRefs: ReferenceEntity queries"},{"name":"pathways","description":"Reactome Data: Pathway related queries"},{"name":"query","description":"Reactome Data: Common data retrieval"},{"name":"diseases","description":"Reactome Data: Disease related queries"},{"name":"database","description":"Reactome Data: Database info queries"},{"name":"exporter","description":"Reactome Data: Format Exporter"},{"name":"search","description":"Reactome Search"}],"paths":{"/data/complex/{id}/subunits":{"get":{"tags":["entities"],"summary":"A list with the entities contained in a given complex","description":"Retrieves the list of subunits that constitute any given complex. In case the complex comprises other complexes, this method recursively traverses the content returning each contained PhysicalEntity. Contained complexes and entity sets can be excluded setting the 'excludeStructures' optional parameter to 'true'","operationId":"getComplexSubunits","parameters":[{"name":"id","in":"path","description":"The complex for which subunits are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5674003"},{"name":"excludeStructures","in":"query","description":"Specifies whether contained complexes and entity sets are excluded in the response","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/complexes/{resource}/{identifier}":{"get":{"tags":["entities"],"summary":"A list of complexes containing the pair (identifier, resource)","description":"Retrieves the list of complexes that contain a given (identifier, resource). The method deconstructs the complexes into all its participants to do so.","operationId":"getComplexesFor","parameters":[{"name":"resource","in":"path","description":"The resource of the identifier for complexes are requested","required":true,"schema":{"type":"string"},"example":"UniProt"},{"name":"identifier","in":"path","description":"The identifier for which complexes are requested","required":true,"schema":{"type":"string"},"example":"P00533"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Pair (identifier, resource) does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/database/name":{"get":{"tags":["database"],"summary":"The name of current database","operationId":"getDBName","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/database/version":{"get":{"tags":["database"],"summary":"The version number of current database","operationId":"getDBVersion","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/discover/{identifier}":{"get":{"tags":["discover"],"summary":"The schema.org for an Event in Reactome knowledgebase","description":"For each event (reaction or pathway) this method generates a json file representing the dataset object as defined by schema.org (http). This is mainly used by search engines in order to index the data","operationId":"eventDiscovery","parameters":[{"name":"identifier","in":"path","description":"An event identifier","required":true,"schema":{"type":"string"},"example":"R-HSA-446203"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDataSet"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDataSet"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDataSet"}}}}}}},"/data/diseases":{"get":{"tags":["diseases"],"summary":"The list of disease objects","description":"It retrieves the list of diseases annotated in Reactome","operationId":"getDiseases","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/diseases/doid":{"get":{"tags":["diseases"],"summary":"The list of diseases DOID","description":"It retrieves the list of disease DOIDs annotated in Reactome","operationId":"getDiseasesSummary","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/entity/{id}/componentOf":{"get":{"tags":["entities"],"summary":"A list of larger structures containing the entity","description":"Retrieves the list of structures (Complexes and Sets) that include the given entity as their component. It should be mentioned that the list includes only simplified entries (type, names, ids) and not full information about each item.","operationId":"getComponentsOf","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComponentOf"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComponentOf"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComponentOf"}}}}}}}},"/data/entity/{id}/in-depth":{"get":{"tags":["entities"],"operationId":"getPhysicalEntityInDepth","parameters":[{"name":"id","in":"path","description":"The complex for which subunits are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5674003"},{"name":"maxDepth","in":"query","description":"Specify the depth needed for the given entity. If negative, fetches everything. If not, fetches the specified amount of nesting","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"attributes","in":"query","description":"Specify the attributes to load for each level of the entity","required":false,"schema":{"type":"string","default":"species,compartment"},"example":"species,compartment"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"object"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/data/entity/{id}/otherForms":{"get":{"tags":["entities"],"summary":"All other forms of a PhysicalEntity","description":"Retrieves a list containing all other forms of the given PhysicalEntity. These other forms are PhysicalEntities that share the same ReferenceEntity identifier, e.g. PTEN H93R[R-HSA-2318524] and PTEN C124R[R-HSA-2317439] are two forms of PTEN.","operationId":"getOtherFormsOf","parameters":[{"name":"id","in":"path","description":"DbId or StId of a PhysicalEntity","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/event/{id}/ancestors":{"get":{"tags":["events"],"summary":"The ancestors of a given event","description":"The Reactome definition of events includes pathways and reactions. Although events are organised in a hierarchical structure, a single event can be in more than one location, i.e. a reaction can take part in different pathways while, in the same way, a sub-pathway can take part in many pathways. Therefore, this method retrieves a list of all possible paths from the requested event to the top level pathway(s).","operationId":"getEventAncestors","parameters":[{"name":"id","in":"path","description":"The event for which the ancestors are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5673001"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/EventProjection"}}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/EventProjection"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/EventProjection"}}}}}}}}},"/data/event/{id}/in-depth":{"get":{"tags":["events"],"operationId":"getEventInDepth","parameters":[{"name":"id","in":"path","description":"The complex for which subunits are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-9612973"},{"name":"maxDepth","in":"query","description":"Specify the depth needed for the given entity. If negative, fetches everything. If not, fetches the specified amount of nesting","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"attributes","in":"query","description":"Specify the attributes to load for each level of the entity","required":false,"schema":{"type":"string","default":"species,compartment"},"example":"species,compartment"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"object"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/data/eventsHierarchy/{species}":{"get":{"tags":["events"],"summary":"The full event hierarchy for a given species","description":"Events (pathways and reactions) in Reactome are organised in a hierarchical structure for every species. By following all 'hasEvent' relationships, this method retrieves the full event hierarchy for any given species. The result is a list of tree structures, one for each TopLevelPathway. Every event in these trees is represented by a PathwayBrowserNode. The latter contains the stable identifier, the name, the species, the url, the type, and the diagram of the particular event.","operationId":"getEventHierarchy","parameters":[{"name":"species","in":"path","description":"Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)","required":true,"schema":{"type":"string"},"example":9606},{"name":"pathwaysOnly","in":"query","description":"Only get pathways","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"token","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> token with the results to be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string"}},{"name":"resource","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> resource for which the results will be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string","default":"TOTAL"}},{"name":"interactors","in":"query","description":"Include interactors","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"importableOnly","in":"query","description":"Filters resources to only includes importable ones","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Species does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PathwayBrowserNode"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PathwayBrowserNode"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PathwayBrowserNode"}}}}}}}},"/data/mapping/{resource}/{identifier}/pathways":{"get":{"tags":["mapping"],"summary":"The lower level pathways where an identifier can be mapped to","description":"Entities play different roles in reactions, and reactions are events that conform a pathway. This method retrieves the pathways for which an identifier plays a role within one or more of their events.","operationId":"getPathways","parameters":[{"name":"resource","in":"path","description":"The <a href='/content/schema/objects/ReferenceDatabase'>resource</a> <b>name</b> for which the identifier is submitted","required":true,"schema":{"type":"string"},"example":"UniProt"},{"name":"identifier","in":"path","description":"The identifier to be mapped","required":true,"schema":{"type":"string"},"example":"PTEN"},{"name":"species","in":"query","description":"Species for which the result is filtered. Accepts <b>taxonomy id</b>, <b>species name</b> and <b>dbId</b>. Important: when identifier points to chemical, this becomes mandatory and if not provided, the default is 'Homo sapiens'","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"No pathways found for the submitted identifier/resource","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/mapping/{resource}/{identifier}/reactions":{"get":{"tags":["mapping"],"summary":"The reactions where an identifier can be mapped to","description":"Entities play different roles in reactions. This method retrieves the reactions for which an identifier plays a role .","operationId":"getReactionsLikeEvent","parameters":[{"name":"resource","in":"path","description":"The <a href='/content/schema/objects/ReferenceDatabase'>resource</a> <b>name</b> for which the identifier is submitted","required":true,"schema":{"type":"string"},"example":"UniProt"},{"name":"identifier","in":"path","description":"The identifier to be mapped","required":true,"schema":{"type":"string"},"example":"PTEN"},{"name":"species","in":"query","description":"Species for which the result is filtered. Accepts <b>taxonomy id</b>, <b>species name</b> and <b>dbId</b>. Important: when identifier points to chemical, this becomes mandatory and if not provided, the default is 'Homo sapiens'","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"No reactions found for the submitted identifier/resource","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/orthologies/ids/species/{speciesId}":{"post":{"tags":["orthology"],"summary":"The orthologies of a given set of events or entities","description":"Reactome uses the set of manually curated human reactions to computationally infer reactions in twenty evolutionarily divergent eukaryotic species for which high-quality whole-genome sequence data are available, and hence a comprehensive and high-quality set of protein predictions exists. Thus, this method retrieves the orthologies for any given set of events or entities in the specified species. <a href=\"/documentation/inferred-events/\" target=\"_blank\">Here</a> you can find more information about the computationally inferred events.","operationId":"getOrthologies","parameters":[{"name":"speciesId","in":"path","description":"The species for which the orthology is requested","required":true,"schema":{"type":"integer","format":"int64"},"example":49633},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"The <b>events</b> or <b>entities</b> for which the orthology is requested","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"404":{"description":"Species does not match with any in current data","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DatabaseObject"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DatabaseObject"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}}},"/data/orthology/{id}/species/{speciesId}":{"get":{"tags":["orthology"],"summary":"The orthology for a given event or entity","description":"Reactome uses the set of manually curated human reactions to computationally infer reactions in twenty evolutionarily divergent eukaryotic species for which high-quality whole-genome sequence data are available, and hence a comprehensive and high-quality set of protein predictions exists. Thus, this method retrieves the orthology for any given event or entity in the specified species. <a href=\"//www.reactome.org/pages/documentation/electronically-inferred-events/\" target=\"_blank\">Here</a> you can find more information about the computationally inferred events.","operationId":"getOrthology","parameters":[{"name":"id","in":"path","description":"The event for which the orthology is requested","required":true,"schema":{"type":"string"},"example":"R-HSA-6799198"},{"name":"speciesId","in":"path","description":"The species for which the orthology is requested","required":true,"schema":{"type":"integer","format":"int64"},"example":49633},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Species does not match with any in current data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}},"/data/participants/{id}":{"get":{"tags":["participants"],"summary":"A list of participants for a given event","description":"Participants contains a PhysicalEntity (dbId, displayName) and a collection of ReferenceEntities (dbId, name, identifier, url)","operationId":"getParticipants","parameters":[{"name":"id","in":"path","description":"DbId or StId of an Event","required":true,"schema":{"type":"string"},"example":5205685},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}}}}}},"/data/participants/{id}/participatingPhysicalEntities":{"get":{"tags":["participants"],"summary":"A list of participating PhysicalEntities for a given event","description":"This method retrieves all the PhysicalEntities that take part in a given event. It is worth mentioning that because a pathway can contain smaller pathways (subpathways), the method also recursively retrieves the PhysicalEntities from every constituent pathway.","operationId":"getParticipatingPhysicalEntities","parameters":[{"name":"id","in":"path","description":"The event for which the participating PhysicalEntities are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5205685"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/participants/{id}/referenceEntities":{"get":{"tags":["participants"],"summary":"A list of participating ReferenceEntities for a given event","description":"PhysicalEntity instances that represent, e.g., the same chemical in different compartments, or different post-translationally modified forms of a single protein, share numerous invariant features such as names, molecular structure and links to external databases like UniProt or ChEBI.<br>To enable storage of this shared information in a single place, and to create an explicit link among all the variant forms of what can also be seen as a single chemical entity, Reactome creates instances of the separate ReferenceEntity class. A ReferenceEntity instance captures the invariant features of a molecule.<br>This method retrieves the ReferenceEntities of all PhysicalEntities that take part in a given event. It is worth mentioning that because a pathway can contain smaller pathways (subpathways), this method also recursively retrieves the ReferenceEntities for all PhysicalEntities in every constituent pathway.","operationId":"getParticipatingReferenceEntities","parameters":[{"name":"id","in":"path","description":"The event for which the participating ReferenceEntities are requested","required":true,"schema":{"type":"string"},"example":5205685},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathway/{id}/containedEvents":{"get":{"tags":["pathways"],"summary":"All the events contained in the given event","description":"Events are the building blocks used in Reactome to represent all biological processes, and they include pathways and reactions. Typically, an event can contain other events. For example, a pathway can contain smaller pathways and reactions. This method recursively retrieves all the events contained in any given event.","operationId":"getContainedEvents","parameters":[{"name":"id","in":"path","description":"The event for which the contained events are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5673001"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"No contained events found in the given event","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathway/{id}/containedEvents/{attributeName}":{"get":{"tags":["pathways"],"summary":"A single property for each event contained in the given event","description":"Events are the building blocks used in Reactome to represent all biological processes, and they include pathways and reactions. Typically, an event can contain other events. For example, a pathway can contain smaller pathways (subpathways) and reactions.<br> This method recursively retrieves a single attribute for each of the events contained in the given event.","operationId":"getContainedEvents_1","parameters":[{"name":"id","in":"path","description":"The event for which the contained events are requested","required":true,"schema":{"type":"string"},"example":"R-HSA-5673001"},{"name":"attributeName","in":"path","description":"Attribute to be filtered","required":true,"schema":{"type":"string"},"example":"stId"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"No contained events found in the given event or invalid attribute name","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/pathways/low/diagram/entity/{id}":{"get":{"tags":["pathways"],"summary":"A list of lower level pathways with diagram containing a given entity or event","description":"This method traverses the event hierarchy and retrieves the list of all lower level pathways that have a diagram and contain the given PhysicalEntity or Event.","operationId":"getPathwaysWithDiagramFor","parameters":[{"name":"id","in":"path","description":"The entity that has to be present in the pathways","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"species","in":"query","description":"The species for which the pathways are requested. Taxonomy identifier (eg: 9606) or species name (eg: 'Homo sapiens')","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier is not present in any pathways with diagram","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathways/low/diagram/entity/{id}/allForms":{"get":{"tags":["pathways"],"summary":"A list of lower level pathways with diagram containing any form of a given entity","description":"This method traverses the event hierarchy and retrieves the list of all lower level pathways that have a diagram and contain the given PhysicalEntity in any of its variant forms. These variant forms include for example different post-translationally modified versions of a single protein, or the same chemical in different compartments.","operationId":"getPathwaysWithDiagramForAllFormsOf","parameters":[{"name":"id","in":"path","description":"The entity (in any of its forms) that has to be present in the pathways","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"species","in":"query","description":"The species for which the pathways are requested. Taxonomy identifier (eg: 9606) or species name (eg: 'Homo sapiens')","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier (in any of its forms) is not present in any pathways with diagram","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathways/low/entity/{id}":{"get":{"tags":["pathways"],"summary":"A list of lower level pathways containing a given entity or event","description":"This method traverses the event hierarchy and retrieves the list of all lower level pathways that contain the given PhysicalEntity or Event.","operationId":"getPathwaysFor","parameters":[{"name":"id","in":"path","description":"The entity that has to be present in the pathways","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"species","in":"query","description":"The species for which the pathways are requested. Taxonomy identifier (eg: 9606) or species name (eg: 'Homo sapiens')","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier is not present in any pathways","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathways/low/entity/{id}/allForms":{"get":{"tags":["pathways"],"summary":"A list of lower level pathways containing any form of a given entity","description":"This method traverses the event hierarchy and retrieves the list of all lower level pathways that contain the given PhysicalEntity in any of its variant forms. These variant forms include for example different post-translationally modified versions of a single protein, or the same chemical in different compartments.","operationId":"getPathwaysForAllFormsOf","parameters":[{"name":"id","in":"path","description":"The entity (in any of its forms) that has to be present in the pathways","required":true,"schema":{"type":"string"},"example":"R-HSA-199420"},{"name":"species","in":"query","description":"The species for which the pathways are requested. Taxonomy identifier (eg: 9606) or species name (eg: 'Homo sapiens')","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier (in any of its forms) is not present in any pathways","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/pathways/top/{species}":{"get":{"tags":["pathways"],"summary":"All Reactome top level pathways","description":"This method retrieves the list of top level pathways for the given species","operationId":"getTopLevelPathways","parameters":[{"name":"species","in":"path","description":"Specifies the species by the taxonomy identifier (eg: 9606) or species name (eg: 'Homo+sapiens')","required":true,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"No TopLevelPathways were found for species","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/people/name/{name}":{"get":{"tags":["person"],"summary":"A list of people with first or last name partly matching a given string","description":"Retrieves a list of people in Reactome with either their first or last name partly matching the given string.","operationId":"queryPersonByName","parameters":[{"name":"name","in":"path","description":"Person's first or last name","required":true,"schema":{"type":"string"},"example":"Steve Jupe"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Given name does not partly match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/people/name/{name}/exact":{"get":{"tags":["person"],"summary":"A list of people with first AND last name exactly matching a given string","description":"Retrieves a list of people in Reactome with their first AND last name matching exactly the given string.","operationId":"findPersonByName","parameters":[{"name":"name","in":"path","description":"Person's first and last name","required":true,"schema":{"type":"string"},"example":"Steve Jupe"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Given name does not exactly match with any in current data","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/person/{id}":{"get":{"tags":["person"],"summary":"A person by his/her identifier","description":"Retrieves a person in Reactome by his/her OrcidId or DbId.","operationId":"findPerson","parameters":[{"name":"id","in":"path","description":"Person identifier: Can be OrcidId or DbId","required":true,"schema":{"type":"string"},"example":"0000-0001-5807-0069"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"OrcidId or DbId does not match with any in current data","content":{"application/json":{"schema":{"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/data/person/{id}/authoredPathways":{"get":{"tags":["person"],"summary":"A list of pathways authored by a given person","description":"Retrieves a list of pathways authored by a given person. OrcidId, DbId or Email can be used to specify the person.","operationId":"getAuthoredPathways","parameters":[{"name":"id","in":"path","description":"Person identifier: Can be OrcidId or DbId","required":true,"schema":{"type":"string"},"example":"0000-0001-5807-0069"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"OrcidId or DbId does not retrieve any pathway","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleEventProjection"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleEventProjection"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleEventProjection"}}}}}}}},"/data/person/{id}/publications":{"get":{"tags":["person"],"summary":"A list of publications authored by a given person","description":"Retrieves a list of publications authored by a given person. OrcidId, DbId or Email can be used to specify the person.","operationId":"getPublicationsOfPerson","parameters":[{"name":"id","in":"path","description":"Person identifier: Can be OrcidId or DbId","required":true,"schema":{"type":"string"},"example":"0000-0001-5807-0069"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"OrcidId or DbId does not match with any publication","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/person/{id}/{attributeName}":{"get":{"tags":["person"],"summary":"A person's property by his/her identifier","description":"Retrieves a specific person's property by his/her OrcidId or DbId.","operationId":"findPerson_1","parameters":[{"name":"id","in":"path","description":"Person identifier: Can be OrcidId or DbId","required":true,"schema":{"type":"string"},"example":"0000-0001-5807-0069"},{"name":"attributeName","in":"path","description":"Attribute to be filtered","required":true,"schema":{"type":"string"},"example":"displayName"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"OrcidId or DbId does not match with any in current data or invalid attribute name","content":{"text/plain":{"schema":{"type":"string"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/query/enhanced/v2/{id}":{"get":{"tags":["query"],"summary":"More information on an entry in Reactome knowledgebase","description":"Based on the given identifier, i.e. stable id or database id, this method queries for an entry in Reactome knowledgebase providing more information. In particular, the retrieved database object has all its properties and direct relationships (relationships of depth 1) filled, while it also includes any second level relationships regarding regulations and catalysts.","operationId":"findEnhancedObjectById","parameters":[{"name":"id","in":"path","description":"DbId or StId of the requested database object","required":true,"schema":{"type":"string"},"example":"R-HSA-60140"},{"name":"fetchIncomingRelationships","in":"query","description":"Whether incoming relationships should be fetched","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"summariseReferenceEntity","in":"query","description":"Whether ReferenceEntity should be summarising its physical entities","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"includeDisease","in":"query","description":"Whether disease specific data should be fetched","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}},"/data/query/enhanced/{id}":{"get":{"tags":["query"],"summary":"More information on an entry in Reactome knowledgebase","description":"Based on the given identifier, i.e. stable id or database id, this method queries for an entry in Reactome knowledgebase providing more information. In particular, the retrieved database object has all its properties and direct relationships (relationships of depth 1) filled, while it also includes any second level relationships regarding regulations and catalysts.","operationId":"findOldEnhancedObjectById","parameters":[{"name":"id","in":"path","description":"DbId or StId of the requested database object","required":true,"schema":{"type":"string"},"example":"R-HSA-60140"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}},"/data/query/ids":{"post":{"tags":["query"],"summary":"A list of entries in Reactome knowledgebase","description":"This method queries for a set of entries in Reactome knowledgebase based on the given list of identifiers. The provided list of identifiers can include stable ids, database ids or a mixture of both. It should be underlined that any duplicated ids are eliminated while only requests containing up to 20 ids are processed.","operationId":"findByIds","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"A comma separated list of identifiers","content":{"text/plain":{"schema":{"type":"string"},"example":"R-HSA-1640170, R-HSA-109581, 199420"}},"required":true},"responses":{"404":{"description":"Identifier does not match with any in current data or invalid attribute name","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseObject"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}}},"/data/query/ids/map":{"post":{"tags":["query"],"summary":"A list of entries with their mapping to the provided identifiers","description":"This method queries for a set of entries in Reactome knowledgebase based on the given list of identifiers. The provided list of identifiers can include stable ids, database ids, old stable ids or a mixture of all. It should be underlined that any duplicated ids are eliminated while only requests containing up to 20 ids are processed.<br>This method is particularly useful for users that still rely on the previous version of stable identifiers to query this API. Please note that those are no longer part of the retrieved objects.","operationId":"findByIdsMap","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"A comma separated list of identifiers","content":{"text/plain":{"schema":{"type":"string"},"example":"R-HSA-1640170, R-HSA-109581, 199420"}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}}},"/data/query/{id}":{"get":{"tags":["query"],"summary":"An entry in Reactome knowledgebase","description":"This method queries for an entry in Reactome knowledgebase based on the given identifier, i.e. stable id or database id. It is worth mentioning that the retrieved database object has all its properties and direct relationships (relationships of depth 1) filled.","operationId":"findById","parameters":[{"name":"id","in":"path","description":"DbId or StId of the requested database object","required":true,"schema":{"type":"string"},"example":"R-HSA-1640170"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data (depth 1)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}},"/data/query/{id}/{attributeName}":{"get":{"tags":["query"],"summary":"A single property of an entry in Reactome knowledgebase","description":"This method queries for a specific property of an entry in Reactome knowledgebase based on the given identifier, i.e. stable id or database id.","operationId":"findById_1","parameters":[{"name":"id","in":"path","description":"DbId or StId of the requested database object","required":true,"schema":{"type":"string"},"example":"R-HSA-1640170"},{"name":"attributeName","in":"path","description":"Attribute to be filtered","required":true,"schema":{"type":"string"},"example":"displayName"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any in current data or invalid attribute name","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/data/schema/model":{"get":{"tags":["schema"],"summary":"A list of Reactome data model","description":"This method retrieves a full specification of all Reactome classes.","operationId":"getSchemaModel","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaNode"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaNode"}}}}}}},"/data/schema/{className}":{"get":{"tags":["schema"],"summary":"A list of entries corresponding to a given schema class","description":"This method retrieves the list of entries in Reactome that belong to the specified schema class. Please take into account that if species is specified to filter the results, schema class needs to be an instance of Event or PhysicalEntity. Additionally, paging is required, while a maximum of 25 entries can be returned per request.","operationId":"getDatabaseObjectsForClassName","parameters":[{"name":"className","in":"path","description":"Schema class name","required":true,"schema":{"type":"string"},"example":"Pathway"},{"name":"species","in":"query","description":"Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)","required":false,"schema":{"type":"string"},"example":9606},{"name":"page","in":"query","description":"Page to be returned","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"offset","in":"query","description":"Number of rows returned. Maximum = 25","required":true,"schema":{"type":"integer","format":"int32"},"example":25},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Schema class does not match with any current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseObject"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseObject"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseObject"}}}}}}}},"/data/schema/{className}/count":{"get":{"tags":["schema"],"summary":"Number of entries belonging to the specified schema class","description":"This method counts the total number of entries in Reactome that belong to the specified schema class. Please take into account that if species is specified to filter the results, schema class needs to be an instance of Event or PhysicalEntity.","operationId":"countEntries","parameters":[{"name":"className","in":"path","description":"Schema class name","required":true,"schema":{"type":"string"},"example":"Pathway"},{"name":"species","in":"query","description":"Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)","required":false,"schema":{"type":"string"},"example":9606},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Schema class does not match with any current data","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}}}},"/data/schema/{className}/min":{"get":{"tags":["schema"],"summary":"A list of simplified entries corresponding to a given schema class","description":"This method retrieves the list of simplified entries in Reactome that belong to the specified schema class. A simplified entry may be considered as a minimised version of the full database object that includes its database id, stable id, displayName and type. Please take into account that if species is specified to filter the results, schema class needs to be an instance of Event or PhysicalEntity. Also, paging is required, while a maximum of 20000 entries can be returned per request.","operationId":"getSimpleDatabaseObjectByClassName","parameters":[{"name":"className","in":"path","description":"Schema class name","required":true,"schema":{"type":"string"},"example":"Pathway"},{"name":"species","in":"query","description":"Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)","required":false,"schema":{"type":"string"},"example":9606},{"name":"page","in":"query","description":"Page to be returned","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"offset","in":"query","description":"Number of rows returned. Maximum = 20000","required":true,"schema":{"type":"integer","format":"int32"},"example":20000},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Schema class does not match with any current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleDatabaseObject"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleDatabaseObject"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleDatabaseObject"}}}}}}}},"/data/schema/{className}/reference":{"get":{"tags":["schema"],"summary":"A list of simplified reference objects corresponding to a given schema class","description":"This method retrieves the list of simplified reference objects that belong to the specified schema class. A reference object includes its database id, external identifier, and external database name. Please take into account that schema class needs to be an instance of ReferenceEntity or ExternalOntology. Also, paging is required, while a maximum of 20000 entries can be returned per request.","operationId":"getSimpleReferencesObjectsByClassName","parameters":[{"name":"className","in":"path","description":"Schema class name. Class needs to an instance of ReferenceEntity or ExternalOntology","required":true,"schema":{"type":"string"},"example":"ReferenceMolecule"},{"name":"page","in":"query","description":"Page to be returned","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"offset","in":"query","description":"Number of rows returned. Maximum = 20000","required":true,"schema":{"type":"integer","format":"int32"},"example":20000},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Schema class does not match with any current data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleReferenceObject"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleReferenceObject"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleReferenceObject"}}}}}}}},"/data/species/all":{"get":{"tags":["species"],"summary":"The list of all species in Reactome","description":"This method retrieves the list of all species in Reactome knowledgebase, sorted by name.","operationId":"getAllSpecies","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/data/species/main":{"get":{"tags":["species"],"summary":"The list of main species in Reactome","description":"This method retrieves the list of main species in Reactome knowledgebase, sorted by name, but having 'Homo sapiens' as the first one. It should be mentioned that for Reactome, main species are considered those have either manually curated or computationally inferred pathways.","operationId":"getSpecies","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/exporter/diagram/{identifier}.{ext}":{"get":{"tags":["exporter"],"summary":"Exports a given pathway diagram to the specified image format (png, jpg, jpeg, svg, gif)","description":"This method accepts identifiers for <a href=\"/content/schema/Event\" target=\"_blank\">Event class</a> instances.<br/>When a diagrammed pathway is provided, the diagram is exported to the specified format.<br/>When a subpathway is provided, the diagram for the parent is exported and the events that are part of the subpathways are selected.<br/>When a reaction is provided, the diagram containing the reaction is exported and the reaction is selected.<br/><br/>Find out more about this method <a href=\"/dev/content-service/diagram-exporter\" target=\"_blank\">here</a>","operationId":"diagramImage_1","parameters":[{"name":"identifier","in":"path","description":"Event identifier (it can be a pathway with diagram, a subpathway or a reaction)","required":true,"schema":{"type":"string"},"example":"R-HSA-177929"},{"name":"ext","in":"path","description":"File extension (defines the image format)","required":true,"schema":{"type":"string","enum":["png","jpg","jpeg","svg","gif"]},"example":"png"},{"name":"quality","in":"query","description":"Result image quality between [1 - 10]. It defines the quality of the final image (Default 5)","required":false,"schema":{"type":"integer","format":"int32","default":5},"example":5},{"name":"flg","in":"query","description":"Gene name, protein or chemical identifier or Reactome identifier used to flag elements in the diagram","required":false,"schema":{"type":"string"}},{"name":"flgInteractors","in":"query","description":"Defines whether to take into account interactors for the flagging","required":false,"schema":{"type":"boolean","default":true}},{"name":"sel","in":"query","description":"Highlight element(s) selection in the diagram. CSV line.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"title","in":"query","description":"Sets whether the name of the pathway is shown below","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"margin","in":"query","description":"Defines the image margin between [0 - 20] (Default 15)","required":false,"schema":{"type":"integer","format":"int32","default":15},"example":15},{"name":"ehld","in":"query","description":"Defines whether textbook-like illustration are taken into account","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"diagramProfile","in":"query","description":"Diagram Color Profile","required":false,"schema":{"type":"string","enum":["Modern","Standard"]},"example":"Modern"},{"name":"token","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> token with the results to be overlaid on top of the given diagram","required":false,"schema":{"type":"string"}},{"name":"resource","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> resource for which the results will be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string","default":"TOTAL"}},{"name":"analysisProfile","in":"query","description":"Analysis  Color Profile","required":false,"schema":{"type":"string","enum":["Standard","Strosobar, Copper%20Plus"]},"example":"Standard"},{"name":"expColumn","in":"query","description":"Expression column. When the token is associated to an expression analysis, this parameter allows specifying the expression column for the overlay","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"image/gif":{},"image/jpeg":{},"image/jpg":{},"image/png":{},"image/svg+xml":{}}},"404":{"description":"Stable Identifier does not match with any of the available diagrams."},"500":{"description":"Could not deserialize diagram file."}}}},"/exporter/document/event/{identifier}.pdf":{"get":{"tags":["exporter"],"summary":"Exports the content of a given event (pathway or reaction) to a PDF document","description":"This method accepts identifiers for <a href=\"/content/schema/Event\" target=\"_blank\">Event class</a> instances.<br/>The generated document contains the details for the given event and, optionally, its children (see level parameter). These details include:<br/> - A diagram image<br/> - Summation<br/> - Literature references<br/> - Edit history<br/> - Other details: type, location, compartments, diseases<br/><br/>Documents can also be overlaid with <a href='/dev/analysis' target=\"_blank\">pathway analysis results</a>","operationId":"eventPdf","parameters":[{"name":"identifier","in":"path","description":"Event identifier (it can be a pathway with diagram, a subpathway or a reaction)","required":true,"schema":{"type":"string"},"example":"R-HSA-177929"},{"name":"level [0 - 1]","in":"query","description":"Number of levels to explore down in the pathways hierarchy [0 - 1]","required":false,"schema":{"type":"integer","format":"int32","default":1},"example":1},{"name":"diagramProfile","in":"query","description":"Diagram Color Profile","required":false,"schema":{"type":"string","enum":["Modern","Standard"]},"example":"Modern"},{"name":"token","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> token with the results to be overlaid on top of the given diagram","required":false,"schema":{"type":"string"}},{"name":"resource","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> resource for which the results will be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string","default":"TOTAL"}},{"name":"importableOnly","in":"query","description":"Filters resources to only includes importable ones","required":false,"schema":{"type":"boolean","default":false}},{"name":"expColumn","in":"query","description":"Expression column. When the token is associated to an expression analysis, this parameter allows specifying the expression column for the overlay","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"analysisProfile","in":"query","description":"Analysis  Color Profile","required":false,"schema":{"type":"string","enum":["Standard","Strosobar","Copper%20Plus"]},"example":"Standard"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{}}},"404":{"description":"Stable Identifier does not match with any of the available diagrams."},"500":{"description":"Could not deserialize diagram file."},"503":{"description":"Service was unable to export to Power Point."}}}},"/exporter/event/{identifier}.sbgn":{"get":{"tags":["exporter"],"summary":"Exports a given pathway or reaction to SBGN","operationId":"eventSBGN","parameters":[{"name":"identifier","in":"path","description":"DbId or StId of the requested pathway or reaction","required":true,"schema":{"type":"string"},"example":"R-HSA-5205682"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier not found"},"422":{"description":"Identifier does not correspond to a pathway or reaction"},"500":{"description":"Internal Server Error"}}}},"/exporter/event/{identifier}.sbml":{"get":{"tags":["exporter"],"summary":"Exports a given pathway or reaction to SBML","operationId":"eventSBML","parameters":[{"name":"identifier","in":"path","description":"DbId or StId of the requested pathway or reaction","required":true,"schema":{"type":"string"},"example":"R-HSA-68616"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier not found"},"422":{"description":"Identifier does not correspond to a pathway or reaction"},"500":{"description":"Internal Server Error"}}}},"/exporter/fireworks/{species}.{ext}":{"get":{"tags":["exporter"],"summary":"Exports a given pathway overview to the specified image format (png, jpg, jpeg, svg, gif)","operationId":"diagramImage","parameters":[{"name":"species","in":"path","description":"Species identifier (it can be the taxonomy id, species name or dbId)","required":true,"schema":{"type":"string"},"example":9606},{"name":"ext","in":"path","description":"File extension (defines the image format)","required":true,"schema":{"type":"string","enum":["png","jpg","jpeg","svg","gif"]},"example":"svg"},{"name":"quality","in":"query","description":"Result image quality between [1 - 10]. It defines the quality of the final image (Default 5)","required":false,"schema":{"type":"integer","format":"int32","default":5},"example":5},{"name":"flg","in":"query","description":"Gene name, protein or chemical identifier or Reactome identifier used to flag elements in the diagram","required":false,"schema":{"type":"string"}},{"name":"flgInteractors","in":"query","description":"Defines whether to take into account interactors for the flagging","required":false,"schema":{"type":"boolean","default":true}},{"name":"sel","in":"query","description":"Highlight element(s) selection in the diagram. CSV line.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"title","in":"query","description":"Sets whether the name of the pathway is shown below","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"margin","in":"query","description":"Defines the image margin between [0 - 20] (Default 15)","required":false,"schema":{"type":"integer","format":"int32","default":15},"example":15},{"name":"diagramProfile","in":"query","description":"Diagram Color Profile","required":false,"schema":{"type":"string","enum":["Copper","Copper plus","Barium Lithium","Calcium Salts"]},"example":"Copper"},{"name":"token","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> token with the results to be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string"}},{"name":"resource","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> resource for which the results will be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string","default":"TOTAL"}},{"name":"expColumn","in":"query","description":"Expression column. When the token is associated to an expression analysis, this parameter allows specifying the expression column for the overlay","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"coverage","in":"query","description":"Set to 'true' to overlay analysis coverage values","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"image/gif":{},"image/jpeg":{},"image/jpg":{},"image/png":{},"image/svg+xml":{}}},"404":{"description":"Species does not match with any of the available."},"500":{"description":"Could not deserialize pathways overview file."}}}},"/exporter/reaction/{identifier}.{ext}":{"get":{"tags":["exporter"],"summary":"Exports a given reaction to the specified image format (png, jpg, jpeg, svg, gif)","description":"This method accepts identifiers for <a href=\"/content/schema/ReactionLikeEvent\" target=\"_blank\">ReactionLikeEvent class</a> instances.","operationId":"reactionImage","parameters":[{"name":"identifier","in":"path","description":"Reaction identifier","required":true,"schema":{"type":"string"},"example":"R-HSA-6787403"},{"name":"ext","in":"path","description":"File extension (defines the image format)","required":true,"schema":{"type":"string","enum":["png","jpg","jpeg","svg","gif"]},"example":"png"},{"name":"quality","in":"query","description":"Result image quality between [1 - 10]. It defines the quality of the final image (Default 5)","required":false,"schema":{"type":"integer","format":"int32","default":5},"example":5},{"name":"flg","in":"query","description":"Gene name, protein or chemical identifier or Reactome identifier used to flag elements in the diagram","required":false,"schema":{"type":"string"}},{"name":"flgInteractors","in":"query","description":"Defines whether to take into account interactors for the flagging","required":false,"schema":{"type":"boolean","default":true}},{"name":"sel","in":"query","description":"Highlight element selection in the diagram.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"title","in":"query","description":"Sets whether the name of the reaction is shown below","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"margin","in":"query","description":"Defines the image margin between [0 - 20] (Default 15)","required":false,"schema":{"type":"integer","format":"int32","default":15},"example":15},{"name":"diagramProfile","in":"query","description":"Diagram Color Profile","required":false,"schema":{"type":"string","enum":["Modern","Standard"]},"example":"Modern"},{"name":"token","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> token with the results to be overlaid on top of the given reaction","required":false,"schema":{"type":"string"}},{"name":"analysisProfile","in":"query","description":"Analysis  Color Profile","required":false,"schema":{"type":"string","enum":["Standard","Strosobar, Copper%20Plus"]},"example":"Standard"},{"name":"resource","in":"query","description":"The <a href=\"/dev/analysis\" target=\"_blank\">analysis</a> resource for which the results will be overlaid on top of the given pathways overview","required":false,"schema":{"type":"string","default":"TOTAL"}},{"name":"expColumn","in":"query","description":"Expression column. When the token is associated to an expression analysis, this parameter allows specifying the expression column for the overlay","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"image/gif":{},"image/jpeg":{},"image/jpg":{},"image/png":{},"image/svg+xml":{}}},"404":{"description":"Stable Identifier does not match with any of the reactions."},"500":{"description":"Could not deserialize diagram file."}}}},"/interactors/psicquic/molecule/{resource}/{acc}/details":{"get":{"tags":["interactors"],"summary":"Retrieve clustered interaction, sorted by score, of a given accession by resource.","operationId":"getProteinDetailsByResource","parameters":[{"name":"resource","in":"path","description":"PSICQUIC Resource","required":true,"schema":{"type":"string"},"example":"MINT"},{"name":"acc","in":"path","description":"Single Accession","required":true,"schema":{"type":"string"},"example":"Q13501"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/psicquic/molecule/{resource}/{acc}/summary":{"get":{"tags":["interactors"],"summary":"Retrieve a summary of a given accession by resource","operationId":"getProteinSummaryByResource","parameters":[{"name":"resource","in":"path","description":"PSICQUIC Resource","required":true,"schema":{"type":"string"},"example":"MINT"},{"name":"acc","in":"path","description":"Single Accession","required":true,"schema":{"type":"string"},"example":"Q13501"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/psicquic/molecules/{resource}/details":{"post":{"tags":["interactors"],"summary":"Retrieve clustered interaction, sorted by score, of a given accession(s) by resource.","operationId":"getProteinsDetailsByResource","parameters":[{"name":"resource","in":"path","description":"PSICQUIC Resource","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>Accessions</b>","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/psicquic/molecules/{resource}/summary":{"post":{"tags":["interactors"],"summary":"Retrieve a summary of a given accession list by resource.","operationId":"getProteinsSummaryByResource","parameters":[{"name":"resource","in":"path","description":"PSICQUIC Resource","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>Accessions</b>","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/psicquic/resources":{"get":{"tags":["interactors"],"summary":"Retrieve a list of all Psicquic Registries services","operationId":"getResources","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsicquicResource"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PsicquicResource"}}}}}}}},"/interactors/static/molecule/enhanced/{acc}/details":{"get":{"tags":["interactors"],"summary":"Retrieve a custom interaction information of a given accession in Reactome knowledgebase for UI to use, including Reactome entity number","operationId":"getCustomInteractionsByAcc","parameters":[{"name":"acc","in":"path","description":"Interactor accession (or identifier)","required":true,"schema":{"type":"string"},"example":"Q13501"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomInteraction"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomInteraction"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomInteraction"}}}}}}}},"/interactors/static/molecule/{acc}/details":{"get":{"tags":["interactors"],"summary":"Retrieve a detailed interaction information of a given accession","operationId":"getProteinDetailsByAcc","parameters":[{"name":"acc","in":"path","description":"Interactor accession (or identifier)","required":true,"schema":{"type":"string"},"example":"Q13501"},{"name":"page","in":"query","description":"For paginating the results","required":false,"schema":{"type":"integer","format":"int32","default":-1}},{"name":"pageSize","in":"query","description":"Number of results to be retrieved","required":false,"schema":{"type":"integer","format":"int32","default":-1}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/static/molecule/{acc}/pathways":{"get":{"tags":["interactors"],"summary":"Retrieve a list of lower level pathways where the interacting molecules can be found","operationId":"getLowerLevelPathways","parameters":[{"name":"acc","in":"path","description":"Accession","required":true,"schema":{"type":"string"},"example":"Q9BXM7-1"},{"name":"species","in":"query","description":"The species name for which the pathways are requested  (e.g. 'Homo sapiens')","required":false,"schema":{"type":"string"},"example":"Homo sapiens"},{"name":"onlyDiagrammed","in":"query","description":"Specifies whether the pathways has to have an associated diagram or not","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/interactors/static/molecule/{acc}/summary":{"get":{"tags":["interactors"],"summary":"Retrieve a summary of a given accession","operationId":"getProteinSummaryByAcc","parameters":[{"name":"acc","in":"path","description":"Accession","required":true,"schema":{"type":"string"},"example":"Q13501"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/static/molecules/details":{"post":{"tags":["interactors"],"summary":"Retrieve a detailed interaction information of a given accession","operationId":"getProteinsDetailsByAccs","parameters":[{"name":"page","in":"query","description":"For paginating the results","required":false,"schema":{"type":"integer","format":"int32","default":-1}},{"name":"pageSize","in":"query","description":"Number of results to be retrieved","required":false,"schema":{"type":"integer","format":"int32","default":-1}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>Interactors</b> Interactor accessions (or identifiers)","content":{"text/plain":{"schema":{"type":"string","description":"Interactor accessions (or identifiers)"},"example":"O95631, P60484"}},"required":true},"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/static/molecules/summary":{"post":{"tags":["interactors"],"summary":"Retrieve a summary of a given accession list","operationId":"getProteinsSummaryByAccs","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>Interactors</b> Interactor accessions (or identifiers)","content":{"text/plain":{"schema":{"type":"string"},"example":"O95631, P60484"}},"required":true},"responses":{"404":{"description":"Could not find the Interactor Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/token/{token}":{"post":{"tags":["interactors"],"summary":"Retrieve custom interactions associated with a token","operationId":"getInteractors","parameters":[{"name":"token","in":"path","description":"A token associated with a data submission","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>Interactors</b> Interactors accessions","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"404":{"description":"Could not find the given token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interactors"}}}}}}},"/interactors/upload/psicquic/url":{"post":{"tags":["interactors"],"summary":"Registry custom PSICQUIC resource","operationId":"registryPsicquicURL","parameters":[{"name":"name","in":"query","description":"Name which identifies the custom psicquic","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>url</b> A URL pointing to the Custom PSICQUIC Resource","content":{"text/plain":{"schema":{"type":"string"},"example":"https://reactome.org/download/current/interactors/reactome.homo_sapiens.interactions.psi-mitab.txt"}},"required":true},"responses":{"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPsicquicResource"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPsicquicResource"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPsicquicResource"}}}}}}},"/interactors/upload/tuple/content":{"post":{"tags":["interactors"],"summary":"Paste file content and get a summary associated with a token","operationId":"postFileContent","parameters":[{"name":"name","in":"query","description":"Name which identifies the sample","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>File Content</b>Paste custom interactors file content","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"413":{"description":"Payload too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"415":{"description":"Unsupported Media Type ('text/plain' or 'text/csv')","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}}}}},"/interactors/upload/tuple/form":{"post":{"tags":["interactors"],"summary":"Parse file and retrieve a summary associated with a token","operationId":"postFile","parameters":[{"name":"name","in":"query","description":"Name which identifies the sample","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Upload your custom interactor file"}},"required":["file"]}}}},"responses":{"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"413":{"description":"Payload too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"415":{"description":"Unsupported Media Type ('text/plain' or 'text/csv')","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}}}}},"/interactors/upload/tuple/url":{"post":{"tags":["interactors"],"summary":"Send file via URL and get a summary associated with a token","operationId":"postUrl","parameters":[{"name":"name","in":"query","description":"Name which identifies the sample","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"<b>url</b> A URL pointing to the Interactors file","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"415":{"description":"Unsupported Media Type ('text/plain' or 'text/csv')","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"431":{"description":"Request Header Fields Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TupleResult"}}}}}}},"/references/mapping/xrefs":{"post":{"tags":["references"],"summary":"All cross references and physical entities associated with a list of given identifiers","description":"Retrieves a paginated list containing cross references and physical entities associated with the matching reference entities identifiers","operationId":"getCrossReferencesForList","parameters":[{"name":"dbFilter","in":"query","description":"Database filter to apply to results","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to process, starting from 0","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size to process, an element being one of the submitted identifiers","required":false,"schema":{"type":"integer","format":"int32","default":100}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"requestBody":{"description":"A comma separated list of identifiers","content":{"text/plain":{"schema":{"type":"string"},"example":"P36897, Q5S007"}},"required":true},"responses":{"404":{"description":"Identifier does not match with any reference entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMapStringCollectionCrossReferenceResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMapStringCollectionCrossReferenceResult"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMapStringCollectionCrossReferenceResult"}}}}}}},"/references/mapping/{identifier}":{"get":{"tags":["references"],"summary":"All ReferenceEntities for a given identifier","description":"Retrieves a list containing all the reference entities for a given identifier.","operationId":"getReferenceEntitiesFor","parameters":[{"name":"identifier","in":"path","description":"Identifier for a given entity","required":true,"schema":{"type":"string"},"example":15377},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any reference entity","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}}}}},"/references/mapping/{identifier}/xrefs":{"get":{"tags":["references"],"summary":"All cross references and physical entities associated with a given identifier","description":"Retrieves a list containing cross references and physical entities associated with the matching reference entities identifier","operationId":"getCrossReferencesFor","parameters":[{"name":"identifier","in":"path","description":"Identifier for a given entity","required":true,"schema":{"type":"string"},"example":"P36897"},{"name":"dbFilter","in":"query","description":"Database filter to apply to results","required":false,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Identifier does not match with any reference entity","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceResult"}}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceResult"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceResult"}}}}}}}},"/search/diagram/{diagram}":{"get":{"tags":["search"],"summary":"Performs a Solr query (diagram widget scoped) for a given QueryObject","operationId":"getDiagramResult","parameters":[{"name":"diagram","in":"path","required":true,"schema":{"type":"string"},"example":"R-HSA-8848021"},{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"MAD"},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"start","in":"query","description":"Start row","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"rows","in":"query","description":"Number of rows to include","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"scope","in":"query","description":"Scope of the query. Can be either REFERENCE_ENTITY to group Physical Entities having a reference entity (Proteins, Genes, etc.) into a single ReferenceEntity, and keep those which don't (Complexes, Sets, etc.) as Physical Entity. PHYSICAL_ENTITY to remove the grouping by reference entity. BOTH to include both types","required":false,"schema":{"type":"string","default":"PHYSICAL_ENTITY","enum":["REFERENCE_ENTITY","PHYSICAL_ENTITY","BOTH"]}},{"name":"includeInteractors","in":"query","description":"Whether the result should consider interactors as part of a diagram","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagramResult"}}}}}}},"/search/diagram/{diagram}/occurrences/{instance}":{"get":{"tags":["search"],"summary":"Performs a Solr query (diagram widget scoped) for a given QueryObject","operationId":"getDiagramOccurrences","parameters":[{"name":"diagram","in":"path","required":true,"schema":{"type":"string"},"example":"R-HSA-68886"},{"name":"instance","in":"path","required":true,"schema":{"type":"string"},"example":"R-HSA-141433"},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"includeInteractors","in":"query","description":"Whether the result should consider interactors as part of a diagram","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagramOccurrencesResult"}}}}}}},"/search/diagram/{pathwayId}/flag":{"get":{"tags":["search"],"summary":"A list of diagram entities plus pathways from the provided list containing the specified identifier","description":"This method traverses the content and checks not only for the main identifier but also for all the cross-references to find the flag targets","operationId":"getEntitiesInDiagramForIdentifier","parameters":[{"name":"pathwayId","in":"path","description":"The pathway to find items to flag","required":true,"schema":{"type":"string"},"example":"R-HSA-446203"},{"name":"query","in":"query","description":"The identifier for the elements to be flagged","required":true,"schema":{"type":"string"},"example":"CTSA"},{"name":"includeInteractors","in":"query","description":"Whether the result should consider interactors as part of a diagram","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagramOccurrencesResult"}}}}}}},"/search/facet":{"get":{"tags":["search"],"summary":"A list of facets corresponding to the whole Reactome search data","description":"This method retrieves faceting information on the whole Reactome search data.","operationId":"facet","parameters":[{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetMapping"}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetMapping"}}}}}}},"/search/facet_query":{"get":{"tags":["search"],"summary":"A list of facets corresponding to a specific query","description":"This method retrieves faceting information on a specific query","operationId":"facet_type","parameters":[{"name":"query","in":"query","description":"Search term","required":true,"schema":{"type":"string"},"example":"TP53"},{"name":"species","in":"query","description":"Species name","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"compartments","in":"query","description":"Compartments to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"keywords","in":"query","description":"Keywords","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"scope","in":"query","description":"Scope of the query. Can be either REFERENCE_ENTITY to group Physical Entities having a reference entity (Proteins, Genes, etc.) into a single ReferenceEntity, and keep those which don't (Complexes, Sets, etc.) as Physical Entity. PHYSICAL_ENTITY to remove the grouping by reference entity. BOTH to include both types","required":false,"schema":{"type":"string","default":"PHYSICAL_ENTITY","enum":["REFERENCE_ENTITY","PHYSICAL_ENTITY","BOTH"]}},{"name":"Force filters","in":"query","description":"Force filters<br>In case where applied filters yield to no results, filters are removed by default to grant results as much as possible. Set <b>Force filters</b> to true to avoid this behaviour","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetMapping"}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetMapping"}}}}}}},"/search/fireworks":{"get":{"tags":["search"],"summary":"Performs a Solr query (fireworks widget scoped) for a given QueryObject","operationId":"getFireworksResult","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"BRAF"},{"name":"species","in":"query","description":"Species name","required":false,"schema":{"type":"string","default":"Homo sapiens"},"example":"Homo sapiens"},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"start","in":"query","description":"Start row","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"scope","in":"query","description":"Scope of the query. Can be either REFERENCE_ENTITY to group Physical Entities having a reference entity (Proteins, Genes, etc.) into a single ReferenceEntity, and keep those which don't (Complexes, Sets, etc.) as Physical Entity. PHYSICAL_ENTITY to remove the grouping by reference entity. BOTH to include both types","required":false,"schema":{"type":"string","default":"PHYSICAL_ENTITY","enum":["REFERENCE_ENTITY","PHYSICAL_ENTITY","BOTH"]}},{"name":"includeInteractors","in":"query","description":"Whether the result should consider interactors as part of a diagram","required":false,"schema":{"type":"boolean","default":false}},{"name":"rows","in":"query","description":"Number of rows to include","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireworksResult"}}}}}}},"/search/fireworks/flag":{"get":{"tags":["search"],"summary":"Performs a Solr query (fireworks widget scoped) for a given QueryObject","operationId":"fireworksFlagging","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"KNTC1"},{"name":"species","in":"query","required":false,"schema":{"type":"string","default":"Homo sapiens"}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FireworksOccurrencesResult"}}}}}}},"/search/pathways/of/{dbId}":{"get":{"tags":["search"],"summary":"Find the different pathways containing a specific entity determined by its dbId. Can customise the output using fields","operationId":"getContainingPathwaysOf","parameters":[{"name":"dbId","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"example":227785},{"name":"includeInteractors","in":"query","description":"Whether the result should consider interactors as part of a diagram","required":false,"schema":{"type":"boolean","default":false}},{"name":"directlyInDiagram","in":"query","description":"Whether the result should exclude higher level diagrams containing pathways, themselves containing the targeted entity","required":false,"schema":{"type":"boolean","default":false}},{"name":"species","in":"query","description":"Species name to filter results for","required":false,"schema":{"type":"string"},"example":"Homo sapiens"},{"name":"fields","in":"query","description":"Fields to include in the response. If empty, retrieves all field available (not recommended)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DB_ID","ST_ID","PHYSICAL_ENTITIES_DB_ID","NAME","SPECIES","SPECIES_FACET","TYPES","KEYWORDS","COMPARTMENT_FACET","ICON_CATEGORIES_FACET","SUMMATION","INFERRED_SUMMATION","REFERENCE_URL","REFERENCE_NAME","REFERENCE_IDENTIFIERS","IS_DISEASE","TYPE","IS_REFERENCE_SUMMARY","HAS_REFERENCE_ENTITY","HAS_EHLD","EXACT_TYPE","DATABASE_NAME","REGULATOR","REGULATOR_ID","REGULATED_ENTITY","REGULATED_ENTITY_ID","COMPARTMENT_NAME","COMPARTMENT_ACCESSION","FIREWORKS_SPECIES","OCCURRENCES","OCCURRENCES_INTERACTOR","DIAGRAMS","DIAGRAMS_INTERACTOR","LLPS","AUTHORED_PATHWAYS","AUTHORED_REACTIONS","REVIEWED_PATHWAYS","REVIEWED_REACTIONS","ORCIDID","TARGET_IDENTIFIER","TARGET_ACCESSIONS","TARGET_GENENAMES","TARGET_SYNONYMS","TARGET_RESOURCE","ICON_NAME","ICON_CATEGORIES","ICON_CURATOR_NAME","ICON_CURATOR_ORCIDID","ICON_CURATOR_URL","ICON_DESIGNER_NAME","ICON_DESIGNER_URL","ICON_DESIGNER_ORCIDID","ICON_REFERENCES","ICON_PHYSICAL_ENTITIES","ICON_EHLDS","DELETED","DELETED_REASON","DELETED_EXPLANATION","DELETED_DATE","DELETED_REPLACEMENT_DB_IDS","DELETED_REPLACEMENT_ST_IDS"]}}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}}}}}}}},"/search/query":{"get":{"tags":["search"],"summary":"Queries Solr against the Reactome knowledgebase","description":"This method performs a Solr query on the Reactome knowledgebase. Results can be provided in a paginated format.","operationId":"getSearchResult","parameters":[{"name":"query","in":"query","description":"Search term","required":true,"schema":{"type":"string"},"example":"Biological oxidations"},{"name":"species","in":"query","description":"Species name","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"compartments","in":"query","description":"Compartments to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"keywords","in":"query","description":"Keywords","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cluster","in":"query","description":"Cluster results","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"parserType","in":"query","description":"Query parser to use","required":false,"schema":{"type":"string","default":"STD","enum":["DISMAX","EDISMAX","STD"]},"example":"STD"},{"name":"Start row","in":"query","description":"Start row","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"rows","in":"query","description":"Number of rows to include","required":false,"schema":{"type":"integer","format":"int32","default":10},"example":10},{"name":"scope","in":"query","description":"Scope of the query. Can be either REFERENCE_ENTITY to group Physical Entities having a reference entity (Proteins, Genes, etc.) into a single ReferenceEntity, and keep those which don't (Complexes, Sets, etc.) as Physical Entity. PHYSICAL_ENTITY to remove the grouping by reference entity. BOTH to include both types","required":false,"schema":{"type":"string","default":"PHYSICAL_ENTITY","enum":["REFERENCE_ENTITY","PHYSICAL_ENTITY","BOTH"]}},{"name":"Force filters","in":"query","description":"Force filters<br>In case where applied filters yield to no results, filters are removed by default to grant results as much as possible. Set <b>Force filters</b> to true to avoid this behaviour","required":false,"schema":{"type":"boolean","default":false}},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"404":{"description":"Entry not found. Targets inform if the term is our scope of annotation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}}}}},"/search/query/paginated":{"get":{"tags":["search"],"summary":"Queries Solr against the Reactome knowledgebase","description":"This method performs a Solr query on the Reactome knowledgebase. Results are in a paginated format, pages count starting from 1.","operationId":"getResult","parameters":[{"name":"query","in":"query","description":"Search term","required":true,"schema":{"type":"string"},"example":"Biological oxidations"},{"name":"page","in":"query","description":"Page, should be strictly positive","required":true,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"rowCount","in":"query","description":"Rows per page","required":true,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"species","in":"query","description":"Species name","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"types","in":"query","description":"Types to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"compartments","in":"query","description":"Compartments to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"keywords","in":"query","description":"Keywords","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cluster","in":"query","description":"Cluster results","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"scope","in":"query","description":"Scope of the query. Can be either REFERENCE_ENTITY to group Physical Entities having a reference entity (Proteins, Genes, etc.) into a single ReferenceEntity, and keep those which don't (Complexes, Sets, etc.) as Physical Entity. PHYSICAL_ENTITY to remove the grouping by reference entity. BOTH to include both types","required":false,"schema":{"type":"string","default":"PHYSICAL_ENTITY","enum":["REFERENCE_ENTITY","PHYSICAL_ENTITY","BOTH"]}},{"name":"parserType","in":"query","description":"Query parser to use","required":false,"schema":{"type":"string","default":"STD","enum":["DISMAX","EDISMAX","STD"]},"example":"STD"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"400":{"description":"One or more parameter is illegal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}},"404":{"description":"Entry not found. Targets inform if the term is our scope of annotation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}},"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedResult"}}}}}}},"/search/spellcheck":{"get":{"tags":["search"],"summary":"Spell-check suggestions for a given query","description":"This method retrieves a list of spell-check suggestions for a given search term.","operationId":"spellcheckerSuggestions","parameters":[{"name":"query","in":"query","description":"Search term","required":true,"schema":{"type":"string"},"example":"repoduction"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/search/suggest":{"get":{"tags":["search"],"summary":"Auto-suggestions for a given query","description":"This method retrieves a list of suggestions for a given search term.","operationId":"suggesterSuggestions","parameters":[{"name":"query","in":"query","description":"Search term","required":true,"schema":{"type":"string"},"example":"platele"},{"name":"view","in":"query","description":"Global parameter - Customise the view to be more concise and/or aggregate relationships","required":false,"schema":{"type":"string","default":"flatten","enum":["flatten","nested","nested-aggregated"],"example":null}},{"name":"includeRef","in":"query","description":"Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}","required":false,"schema":{"type":"boolean","default":false,"example":null}}],"responses":{"406":{"description":"Not acceptable according to the accept headers sent in the request","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"500":{"description":"Internal Error in SolR","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}},"components":{"schemas":{"ComponentOf":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"}},"schemaClasses":{"type":"array","items":{"type":"string"}},"species":{"type":"array","items":{"type":"string"}},"stIds":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}}},"CrossReferenceResult":{"type":"object","properties":{"crossReferences":{"type":"array","items":{"$ref":"#/components/schemas/ShortCrossReference"}},"physicalEntities":{"type":"array","items":{"type":"string"}},"reference":{"type":"string"}}},"CustomInteraction":{"type":"object","properties":{"databaseName":{"type":"string"},"dbId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"entitiesCount":{"type":"integer","format":"int64"},"evidenceCount":{"type":"integer","format":"int64"},"evidenceURL":{"type":"string"},"geneName":{"type":"array","items":{"type":"string"}},"identifier":{"type":"string"},"score":{"type":"number","format":"double"},"speciesName":{"type":"string"},"url":{"type":"string"},"variantIdentifier":{"type":"string"}}},"CustomPsicquicResource":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/Summary"}}},"DatabaseObject":{"type":"object","properties":{"className":{"type":"string"},"created":{"type":"object"},"dbId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"modified":{"type":"object"},"schemaClass":{"type":"string"},"stId":{"type":"string"},"stIdVersion":{"type":"string"}}},"DiagramOccurrencesResult":{"type":"object","properties":{"diagramEntity":{"type":"string"},"inDiagram":{"type":"boolean"},"interactsWith":{"type":"array","items":{"type":"string"}},"occurrences":{"type":"array","items":{"type":"string"}}}},"DiagramResult":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}},"facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetContainer"}},"found":{"type":"integer","format":"int64"}}},"Entry":{"type":"object","properties":{"authoredPathways":{"type":"string"},"authoredReactions":{"type":"string"},"compartmentAccession":{"type":"array","items":{"type":"string"}},"compartmentNames":{"type":"array","items":{"type":"string"}},"databaseName":{"type":"string"},"date":{"type":"string","format":"date-time"},"dbId":{"type":"string"},"deleted":{"type":"boolean"},"disease":{"type":"boolean"},"exactType":{"type":"string"},"explanation":{"type":"string"},"fireworksSpecies":{"type":"array","items":{"type":"string"}},"hasEHLD":{"type":"boolean"},"hasReferenceEntity":{"type":"boolean"},"icon":{"type":"boolean"},"iconCategories":{"type":"array","items":{"type":"string"}},"iconCuratorName":{"type":"string"},"iconCuratorOrcidId":{"type":"string"},"iconCuratorUrl":{"type":"string"},"iconDesignerName":{"type":"string"},"iconDesignerOrcidId":{"type":"string"},"iconDesignerUrl":{"type":"string"},"iconEhlds":{"type":"array","items":{"type":"string"}},"iconName":{"type":"string"},"iconPhysicalEntities":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/IconPhysicalEntity"}},"iconReferences":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"instanceTypeExplanation":{"type":"string"},"isDisease":{"type":"boolean"},"name":{"type":"string"},"orcidId":{"type":"string"},"reason":{"type":"string"},"referenceIdentifier":{"type":"string"},"referenceName":{"type":"string"},"referenceURL":{"type":"string"},"regulatedEntity":{"type":"string"},"regulatedEntityId":{"type":"string"},"regulator":{"type":"string"},"regulatorId":{"type":"string"},"replacementDbIds":{"type":"array","items":{"type":"integer","format":"int64"}},"replacementStIds":{"type":"array","items":{"type":"string"}},"reviewedPathways":{"type":"string"},"reviewedReactions":{"type":"string"},"species":{"type":"array","items":{"type":"string"}},"stId":{"type":"string"},"summation":{"type":"string"},"type":{"type":"string"}}},"EventProjection":{"type":"object","properties":{"category":{"type":"string"},"dbId":{"type":"integer","format":"int64"},"definition":{"type":"string"},"diagramHeight":{"type":"integer","format":"int32"},"diagramWidth":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"doi":{"type":"string"},"hasDiagram":{"type":"boolean"},"hasEHLD":{"type":"boolean"},"inDisease":{"type":"boolean"},"inferred":{"type":"boolean"},"isCanonical":{"type":"string"},"name":{"type":"array","items":{"type":"string"}},"oldStId":{"type":"string"},"releaseDate":{"type":"string"},"releaseStatus":{"type":"string"},"schemaClass":{"type":"string"},"speciesName":{"type":"string"},"stId":{"type":"string"},"stIdVersion":{"type":"string"}}},"FacetContainer":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"FacetList":{"type":"object","properties":{"available":{"type":"array","items":{"$ref":"#/components/schemas/FacetContainer"}},"selected":{"type":"array","items":{"$ref":"#/components/schemas/FacetContainer"}}}},"FacetMapping":{"type":"object","properties":{"compartmentFacet":{"$ref":"#/components/schemas/FacetList"},"iconCategoriesFacet":{"$ref":"#/components/schemas/FacetList"},"keywordFacet":{"$ref":"#/components/schemas/FacetList"},"speciesFacet":{"$ref":"#/components/schemas/FacetList"},"totalNumFount":{"type":"integer","format":"int64"},"typeFacet":{"$ref":"#/components/schemas/FacetList"}}},"FireworksOccurrencesResult":{"type":"object","properties":{"interactsWith":{"type":"array","items":{"type":"string"}},"llps":{"type":"array","items":{"type":"string"}}}},"FireworksResult":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}},"facets":{"type":"array","items":{"$ref":"#/components/schemas/FacetContainer"}},"found":{"type":"integer","format":"int64"},"targetResults":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/TargetResult"}}}},"GroupedResult":{"type":"object","properties":{"numberOfGroups":{"type":"integer","format":"int32"},"numberOfMatches":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Result"}},"rowCount":{"type":"integer","format":"int32"},"targetResults":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/TargetResult"}}}},"IconPhysicalEntity":{"type":"object","properties":{"compartments":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"stId":{"type":"string"},"type":{"type":"string"}}},"Interactor":{"type":"object","properties":{"acc":{"type":"string","description":"This is the interactor accession (or identifier)."},"accURL":{"type":"string","description":"This represents the URL for given accession."},"alias":{"type":"string","description":"This is the Gene name of the given accession."},"evidences":{"type":"integer","description":"This is the Interactions evidences.","format":"int32"},"evidencesURL":{"type":"string","description":"This represents the URL for the given interactions identifiers."},"id":{"type":"integer","description":"This is an auto increment counter which represents an unique number for the interaction.","format":"int64"},"score":{"type":"number","description":"This represents the confidence value (score) of an interaction.","format":"double"}},"description":"List of Interactors that interacts with the given accession."},"InteractorEntity":{"type":"object","properties":{"acc":{"type":"string","description":"This is the interactor accession (or identifier)."},"count":{"type":"integer","description":"This is the number of interactions for the given accession.","format":"int32"},"interactors":{"type":"array","description":"List of Interactors that interacts with the given accession.","items":{"$ref":"#/components/schemas/Interactor"}}},"description":"This is the list of entities which have been requested."},"Interactors":{"type":"object","properties":{"entities":{"type":"array","description":"This is the list of entities which have been requested.","items":{"$ref":"#/components/schemas/InteractorEntity"}},"resource":{"type":"string","description":"This is the resource where interactors have been queried."}}},"PageMapStringCollectionCrossReferenceResult":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceResult"}}}},"empty":{"type":"boolean"},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"size":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/Sort"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"}}},"PageableObject":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"sort":{"$ref":"#/components/schemas/Sort"},"unpaged":{"type":"boolean"}}},"Participant":{"type":"object","properties":{"displayName":{"type":"string"},"peDbId":{"type":"integer","format":"int64"},"refEntities":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantRefEntities"}},"schemaClass":{"type":"string"}}},"ParticipantRefEntities":{"type":"object","properties":{"dbId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"icon":{"type":"string"},"identifier":{"type":"string"},"schemaClass":{"type":"string"},"stId":{"type":"string"},"url":{"type":"string"}}},"PathwayBrowserNode":{"type":"object","properties":{"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PathwayBrowserNode"}},"diagram":{"type":"boolean"},"name":{"type":"string"},"species":{"type":"string"},"stId":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}}},"PsicquicResource":{"type":"object","properties":{"active":{"type":"boolean"},"name":{"type":"string"},"restURL":{"type":"string"},"soapURL":{"type":"string"}}},"Result":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}},"entriesCount":{"type":"integer","format":"int64"},"rowCount":{"type":"integer","format":"int32"},"typeName":{"type":"string"}}},"SchemaCreator":{"type":"object"},"SchemaDataCatalog":{"type":"object","properties":{"@type":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"SchemaDataDownload":{"type":"object","properties":{"@type":{"type":"string"},"contentUrl":{"type":"string"},"encodingFormat":{"type":"string"},"fileFormat":{"type":"string"}}},"SchemaDataSet":{"type":"object","properties":{"@context":{"type":"string"},"@type":{"type":"string"},"citation":{"type":"array","items":{"type":"string"}},"creator":{"type":"array","items":{"$ref":"#/components/schemas/SchemaCreator"}},"description":{"type":"string"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDataDownload"}},"includedInDataCatalog":{"$ref":"#/components/schemas/SchemaDataCatalog"},"keywords":{"type":"array","items":{"type":"string"}},"license":{"type":"string"},"name":{"type":"string"},"sameAs":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"version":{"type":"string"}}},"SchemaNode":{"type":"object","properties":{"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SchemaNode"}},"className":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"ShortCrossReference":{"type":"object","properties":{"databaseName":{"type":"string"},"identifier":{"type":"string"},"url":{"type":"string"}}},"SimpleDatabaseObject":{"type":"object","properties":{"dbId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"labels":{"type":"array","writeOnly":true,"items":{"type":"string"}},"schemaClass":{"type":"string"},"stId":{"type":"string"}}},"SimpleEventProjection":{"type":"object","properties":{"authorDbId":{"type":"integer","format":"int64"},"dateTime":{"type":"string"},"dbId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"doi":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}},"schemaClass":{"type":"string"},"speciesName":{"type":"string"},"stId":{"type":"string"}}},"SimpleReferenceObject":{"type":"object","properties":{"databaseName":{"type":"string"},"dbId":{"type":"integer","format":"int64"},"identifier":{"type":"string"}}},"Sort":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}},"Summary":{"type":"object","properties":{"fileName":{"type":"string"},"interactions":{"type":"integer","format":"int32"},"interactors":{"type":"integer","format":"int32"},"name":{"type":"string"},"token":{"type":"string"}}},"TargetResult":{"type":"object","properties":{"resource":{"type":"string"},"target":{"type":"boolean"},"term":{"type":"string"}}},"TupleResult":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/Summary"},"warningMessages":{"type":"array","items":{"type":"string"}}}}}}}