{"swagger":"2.0","info":{"description":"Download Files API documentation for EMDB","version":"1.0","title":"Download Files Documentation"},"host":"www.covid19dataportal.org","basePath":"/api/backend","tags":[{"name":"EMDB Download Files API","description":"EMDB Download Controller"},{"name":"EBI Search result download Files API","description":"Ebi Search Result Controller"},{"name":"COVID-19 Data Portal API","description":"Ebi Global Search Controller"}],"paths":{"/category-counts":{"post":{"tags":["COVID-19 Data Portal API"],"summary":"getCounts","operationId":"getCountsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EbiSearchCountRequest"}}},{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"dev"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/ebisearch":{"get":{"tags":["EBI Search result download Files API"],"summary":"downloadEbiSearchResult","operationId":"downloadEbiSearchResultUsingGET","consumes":["application/json"],"produces":["application/xml","text/plain"],"parameters":[{"name":"domain","in":"query","description":"The EBI Search data domain to search against. Is mandatory.","required":true,"type":"string"},{"name":"query","in":"query","description":"A set of search parameters joined by logical operators (AND, OR, NOT) and bound by double quotes. ","required":false,"type":"string"},{"name":"facets","in":"query","description":"A set of facets and its values to filter the ebi search result. A comma separated list of selected facet values. Check https://www.ebi.ac.uk/ebisearch/apidoc.ebi/facet for more details.","required":false,"type":"string"},{"name":"start","in":"query","description":"The index of the first entry in the results. limit 1,000,000","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"The number of entries to retrieve.","required":false,"type":"integer","format":"int32"},{"name":"format","in":"query","description":"Response format. Supported formats are : tsv, csv and xml.","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated values of field identifiers to retrieve.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["EBI Search result download Files API"],"summary":"downloadEbiSearchEntries","operationId":"downloadEbiSearchEntriesUsingPOST","consumes":["application/x-www-form-urlencoded"],"produces":["application/xml","text/plain"],"parameters":[{"name":"accessions","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"fileType","in":"query","required":false,"type":"string"},{"name":"resourceName","in":"query","required":false,"type":"string"},{"name":"fields","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/files":{"post":{"tags":["EMDB Download Files API"],"summary":"getFiles","operationId":"getFilesUsingPOST","consumes":["application/x-www-form-urlencoded"],"produces":["application/zip"],"parameters":[{"name":"accessions","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"fileType","in":"query","required":false,"type":"string"},{"name":"resourceName","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/global-search":{"post":{"tags":["COVID-19 Data Portal API"],"summary":"searchCategory","operationId":"searchCategoryUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"domains","description":"domains","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EbiGlobalSearchDomainRequest"}}},{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"},{"name":"limit","in":"query","description":"limit","required":false,"type":"integer","default":3,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/search-cross-references":{"post":{"tags":["COVID-19 Data Portal API"],"summary":"searchCrossReferences","operationId":"searchCrossReferencesUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/EbiCrossReferenceRequest"}},{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"dev"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CrossReferenceResult"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/search-internal-cross-references":{"post":{"tags":["COVID-19 Data Portal API"],"summary":"searchInternalCrossReferences","operationId":"searchInternalCrossReferencesUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/EbiInternalCrossReferenceRequest"}},{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"dev"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CrossReferenceResult"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/clear-caches":{"post":{"tags":["COVID-19 Data Portal API"],"summary":"clearCaches","operationId":"clearCachesUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/cumulative-centers-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"getInstSeqData","operationId":"getInstSeqDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/cumulative-countries-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"fetchCumulativeCountriesData","operationId":"fetchCumulativeCountriesDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/raw-cumulative-centers-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"getInstRawSeqData","operationId":"getInstRawSeqDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/raw-cumulative-countries-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"fetchRawCumulativeCountriesData","operationId":"fetchRawCumulativeCountriesDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/raw-sequences-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"fetchRawSequencesData","operationId":"fetchRawSequencesDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/statistics/sequences-data":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"fetchSequencesData","operationId":"fetchSequencesDataUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"env","in":"query","description":"env","required":false,"type":"string","default":"prod"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/{category}/{domainId}":{"get":{"tags":["COVID-19 Data Portal API"],"summary":"search","operationId":"searchUsingGET","consumes":["application/json"],"produces":["application/xml","application/json","text/plain"],"parameters":[{"name":"category","in":"path","description":"category","required":true,"type":"string"},{"name":"domainId","in":"path","description":"domainId","required":true,"type":"string"},{"name":"query","in":"query","description":"A set of search parameters joined by logical operators (AND, OR, NOT) and bound by double quotes. ","required":false,"type":"string"},{"name":"facets","in":"query","description":"A set of facets and its values to filter the ebi search result. A comma separated list of selected facet values. Check https://www.ebi.ac.uk/ebisearch/apidoc.ebi/facet for more details.","required":false,"type":"string"},{"name":"page","in":"query","description":"The page number to search.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"size","in":"query","description":"The number of entries to retrieve.","required":false,"type":"integer","default":15,"format":"int32"},{"name":"fields","in":"query","description":"Comma separated values of field identifiers to retrieve.","required":false,"type":"string"},{"name":"facetFields","in":"query","description":"Comma separated values of facet field identifiers to retrieve.","required":false,"type":"string"},{"name":"format","in":"query","description":"Response format. Supported formats are : tsv, csv and xml.","required":false,"type":"string","default":"json"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ByteArrayResource"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"ByteArrayResource":{"type":"object","properties":{"byteArray":{"type":"string","format":"byte"},"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}}},"CrossReferenceDomain":{"type":"object","properties":{"alias":{"type":"string"},"domainId":{"type":"string"},"id":{"type":"string"},"internal":{"type":"boolean"},"prefixedQuery":{"type":"string"},"referenceEntryCount":{"type":"integer","format":"int32"},"singleReference":{"$ref":"#/definitions/SearchReference"}}},"CrossReferenceResult":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/definitions/CrossReferenceDomain"}},"id":{"type":"string"}}},"EbiCrossReferenceRequest":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/definitions/CrossReferenceDomain"}},"entries":{"type":"array","items":{"$ref":"#/definitions/SearchResultEntry"}}}},"EbiGlobalSearchDomainRequest":{"type":"object","properties":{"domainId":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"query":{"type":"string"}}},"EbiInternalCrossReferenceRequest":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/definitions/CrossReferenceDomain"}},"entries":{"type":"array","items":{"$ref":"#/definitions/SearchResultEntry"}},"queries":{"type":"array","items":{"$ref":"#/definitions/EbiSearchInternalCrossRefQuery"}}}},"EbiSearchCountDomainRequest":{"type":"object","properties":{"id":{"type":"string"},"prefixedQuery":{"type":"string"},"query":{"type":"string"}}},"EbiSearchCountRequest":{"type":"object","properties":{"categoryDomainId":{"type":"string"},"domains":{"type":"array","items":{"$ref":"#/definitions/EbiSearchCountDomainRequest"}}}},"EbiSearchInternalCrossRefQuery":{"type":"object","properties":{"alias":{"type":"string"},"domainId":{"type":"string"},"query":{"type":"string"}}},"FieldURL":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}}},"InputStream":{"type":"object"},"Map«string,int»":{"type":"object","additionalProperties":{"$ref":"#/definitions/Integer"}},"SearchReference":{"type":"object","properties":{"acc":{"type":"string"},"fieldURLs":{"type":"array","items":{"$ref":"#/definitions/FieldURL"}},"id":{"type":"string"},"source":{"type":"string"}}},"SearchResultEntry":{"type":"object","properties":{"acc":{"type":"string"},"id":{"type":"string"},"source":{"type":"string"}}},"StreamingResponseBody":{"type":"object"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}}},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}}}}}