{
  "opencollection": "1.0.0",
  "info": {
    "name": "Fence OpenAPI Specification admin/user export API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "export",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Export entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://example.domain/v0/submission/<program>/<project>/export",
            "params": [
              {
                "name": "program",
                "value": "",
                "type": "path",
                "description": "The program to which the submitter belongs and in which the entities will be created. The `program` is the human-readable name, e.g. TCGA."
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The project to which the submitter belongs and in which the entities will be created. The `project` is the human-readable code, e.g. BRCA."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "one or a list of node IDs seperated by commas."
              },
              {
                "name": "node_label",
                "value": "",
                "type": "query",
                "description": "type of nodes to look up, for example ``'case'``"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "output format, ``json`` or ``tsv`` or ``csv``; default is ``tsv``"
              },
              {
                "name": "with_children",
                "value": "",
                "type": "query",
                "description": "whether to recursively find children or not; default is False"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "category of node to filter on children. Example: ``clinical``"
              },
              {
                "name": "without_id",
                "value": "",
                "type": "query",
                "description": "whether to include the ids in the export file; default is False"
              }
            ]
          },
          "docs": "Return a file with the requested entities as an attachment. Either ``ids`` or ``node_label`` must be provided in the parameters. When both are provided, ``node_label`` is ignored and ``ids`` is used. If ``ids`` is provided, all entities matching given ``ids`` will be exported. If there is only one entity type in the output, it will return a ``{node_type}.tsv`` or ``{node_type}.json`` file, e.g.: ``aliquot.tsv``. If there are multiple entity types, it returns ``gdc_export_{one_time_sha}.tar.gz`` "
        },
        {
          "info": {
            "name": "Export entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://example.domain/v0/submission/<program>/<project>/export",
            "params": [
              {
                "name": "program",
                "value": "",
                "type": "path",
                "description": "The program to which the submitter belongs and in which the entities will be created. The `program` is the human-readable name, e.g. TCGA."
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The project to which the submitter belongs and in which the entities will be created. The `project` is the human-readable code, e.g. BRCA."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "one or a list of node IDs seperated by commas."
              },
              {
                "name": "node_label",
                "value": "",
                "type": "query",
                "description": "type of nodes to look up, for example ``'case'``"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "output format, ``json`` or ``tsv`` or ``csv``; default is ``tsv``"
              },
              {
                "name": "with_children",
                "value": "",
                "type": "query",
                "description": "whether to recursively find children or not; default is False"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "category of node to filter on children. Example: ``clinical``"
              },
              {
                "name": "without_id",
                "value": "",
                "type": "query",
                "description": "whether to include the ids in the export file; default is False"
              }
            ]
          },
          "docs": "Return a file with the requested entities as an attachment. Either ``ids`` or ``node_label`` must be provided in the parameters. When both are provided, ``node_label`` is ignored and ``ids`` is used. If ``ids`` is provided, all entities matching given ``ids`` will be exported. If there is only one entity type in the output, it will return a ``{node_type}.tsv`` or ``{node_type}.json`` file, e.g.: ``aliquot.tsv``. If there are multiple entity types, it returns ``gdc_export_{one_time_sha}.tar.gz`` "
        }
      ]
    }
  ],
  "bundled": true
}