{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pathway Analysis Service database schema API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "schema",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "A list of Reactome data model",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/AnalysisService/data/schema/model",
            "params": [
              {
                "name": "view",
                "value": "",
                "type": "query",
                "description": "Global parameter - Customise the view to be more concise and/or aggregate relationships"
              },
              {
                "name": "includeRef",
                "value": "",
                "type": "query",
                "description": "Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}"
              }
            ]
          },
          "docs": "This method retrieves a full specification of all Reactome classes."
        },
        {
          "info": {
            "name": "A list of entries corresponding to a given schema class",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/AnalysisService/data/schema/:className",
            "params": [
              {
                "name": "className",
                "value": "Pathway",
                "type": "path",
                "description": "Schema class name"
              },
              {
                "name": "species",
                "value": "9606",
                "type": "query",
                "description": "Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page to be returned"
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Number of rows returned. Maximum = 25"
              },
              {
                "name": "view",
                "value": "",
                "type": "query",
                "description": "Global parameter - Customise the view to be more concise and/or aggregate relationships"
              },
              {
                "name": "includeRef",
                "value": "",
                "type": "query",
                "description": "Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Number of entries belonging to the specified schema class",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/AnalysisService/data/schema/:className/count",
            "params": [
              {
                "name": "className",
                "value": "Pathway",
                "type": "path",
                "description": "Schema class name"
              },
              {
                "name": "species",
                "value": "9606",
                "type": "query",
                "description": "Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)"
              },
              {
                "name": "view",
                "value": "",
                "type": "query",
                "description": "Global parameter - Customise the view to be more concise and/or aggregate relationships"
              },
              {
                "name": "includeRef",
                "value": "",
                "type": "query",
                "description": "Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "A list of simplified entries corresponding to a given schema class",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/AnalysisService/data/schema/:className/min",
            "params": [
              {
                "name": "className",
                "value": "Pathway",
                "type": "path",
                "description": "Schema class name"
              },
              {
                "name": "species",
                "value": "9606",
                "type": "query",
                "description": "Allowed species filter: SpeciesName (eg: Homo sapiens) SpeciesTaxId (eg: 9606)"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page to be returned"
              },
              {
                "name": "offset",
                "value": "20000",
                "type": "query",
                "description": "Number of rows returned. Maximum = 20000"
              },
              {
                "name": "view",
                "value": "",
                "type": "query",
                "description": "Global parameter - Customise the view to be more concise and/or aggregate relationships"
              },
              {
                "name": "includeRef",
                "value": "",
                "type": "query",
                "description": "Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "A list of simplified reference objects corresponding to a given schema class",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/AnalysisService/data/schema/:className/reference",
            "params": [
              {
                "name": "className",
                "value": "ReferenceMolecule",
                "type": "path",
                "description": "Schema class name. Class needs to an instance of ReferenceEntity or ExternalOntology"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page to be returned"
              },
              {
                "name": "offset",
                "value": "20000",
                "type": "query",
                "description": "Number of rows returned. Maximum = 20000"
              },
              {
                "name": "view",
                "value": "",
                "type": "query",
                "description": "Global parameter - Customise the view to be more concise and/or aggregate relationships"
              },
              {
                "name": "includeRef",
                "value": "",
                "type": "query",
                "description": "Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}"
              }
            ]
          },
          "docs": "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."
        }
      ]
    }
  ],
  "bundled": true
}