{"info":{"description":"API to FlatHUB data repository.  Most operations support GET and POST, either of which accepts JSON request bodies or query parameters.  In most cases, query parameters are ignored when there is a request body.  Structured query values have simplified representations described in the schema, or most support JSON- (and uri-)encoded values (e.g., field={\"gte\":0}&fields=[\"field\"]).","title":"FlatHUB API","version":"2.0"},"servers":[{"url":"http://astrosims.flatironinstitute.org/api"},{"url":"https://flathub.flatironinstitute.org/api","description":"production"}],"paths":{"/":{"get":{"summary":"Get the list of available dataset catalogs","operationId":"top","responses":{"200":{"$ref":"#/components/responses/top"}}}},"/{catalog}":{"get":{"summary":"Get full metadata about a specific catalog","operationId":"catalog","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/catalog"}}}},"/{catalog}/schema.sql":{"get":{"summary":"Get a SQL representation of the catalog schema (no data)","operationId":"schema.sql","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/schema.sql"}}}},"/{catalog}/schema.csv":{"get":{"summary":"Get a CSV representation of the catalog schema (no data)","operationId":"schema.csv","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/schema.csv"}}}},"/{catalog}/data":{"get":{"summary":"Get a sample of raw data rows","operationId":"data","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"$ref":"#/components/parameters/filters"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/sort"},{"in":"query","name":"count","required":true,"schema":{"description":"number of rows to return","maximum":10000,"minimum":0,"type":"integer"},"style":"form"},{"in":"query","name":"offset","schema":{"default":0,"description":"start at this row offset (0 means first)","maximum":0,"minimum":0,"type":"integer"},"style":"form"},{"in":"query","name":"object","schema":{"default":false,"description":"return JSON objects instead of arrays of data","type":"boolean"},"style":"form"}],"responses":{"200":{"$ref":"#/components/responses/data"}}},"post":{"summary":"Get a sample of raw data rows","operationId":"dataPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"},{"description":"data to return","properties":{"count":{"description":"number of rows to return","maximum":10000,"minimum":0,"type":"integer"},"fields":{"$ref":"#/components/schemas/FieldList"},"object":{"default":false,"description":"return JSON objects instead of arrays of data","type":"boolean"},"offset":{"default":0,"description":"start at this row offset (0 means first)","maximum":0,"minimum":0,"type":"integer"},"sort":{"$ref":"#/components/schemas/sort"}},"required":["fields","count"],"type":"object"}],"title":"data request"}}}},"responses":{"200":{"$ref":"#/components/responses/data"}}}},"/{catalog}/data/{format}":{"get":{"summary":"Download raw data in bulk","operationId":"download","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["npy","npy.gz","ecsv","ecsv.gz","json","json.gz","fits","fits.gz","csv","csv.gz","ndjson","ndjson.gz"],"type":"string"}},{"$ref":"#/components/parameters/filters"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/sort"}],"responses":{"200":{"$ref":"#/components/responses/download"}}},"post":{"summary":"Download raw data in bulk","operationId":"downloadPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["npy","npy.gz","ecsv","ecsv.gz","json","json.gz","fits","fits.gz","csv","csv.gz","ndjson","ndjson.gz"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"},{"description":"data to return","properties":{"fields":{"$ref":"#/components/schemas/FieldList"},"sort":{"$ref":"#/components/schemas/sort"}},"required":["fields"],"type":"object"}],"title":"download request"}}}},"responses":{"200":{"$ref":"#/components/responses/download"}}}},"/{catalog}/count":{"get":{"summary":"Get count of matching rows (given some filters)","operationId":"count","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"$ref":"#/components/parameters/filters"}],"responses":{"200":{"$ref":"#/components/responses/count"}}},"post":{"summary":"Get count of matching rows (given some filters)","operationId":"countPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"}],"title":"count request"}}}},"responses":{"200":{"$ref":"#/components/responses/count"}}}},"/{catalog}/stats":{"get":{"summary":"Get statistics about fields (given some filters)","operationId":"stats","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"$ref":"#/components/parameters/filters"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/stats"}}},"post":{"summary":"Get statistics about fields (given some filters)","operationId":"statsPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"},{"description":"stats to request","properties":{"fields":{"$ref":"#/components/schemas/FieldList"}},"title":"stats fields","type":"object"}],"title":"stats request"}}}},"responses":{"200":{"$ref":"#/components/responses/stats"}}}},"/{catalog}/histogram":{"get":{"summary":"Get a histogram of data across one or more fields","operationId":"histogram","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"$ref":"#/components/parameters/filters"},{"description":"field(s) along which to calculate histograms (see descriptions for non-standard formatting of size/log)","explode":false,"in":"query","name":"fields","required":true,"schema":{"$ref":"#/components/schemas/HistogramList"},"style":"form"},{"description":"optional field within which to calculate quartiles","in":"query","name":"quartiles","schema":{"$ref":"#/components/schemas/FieldName"}}],"responses":{"200":{"$ref":"#/components/responses/histogram"}}},"post":{"summary":"Get a histogram of data across one or more fields","operationId":"histogramPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"},{"description":"histogram axes and an optional quartiles axis for which quartiles are calculated in each inner-most histogram bucket","properties":{"fields":{"$ref":"#/components/schemas/HistogramList"},"quartiles":{"$ref":"#/components/schemas/FieldName"}},"required":["fields"],"title":"histogram parameters","type":"object"}],"title":"histogram request"}}}},"responses":{"200":{"$ref":"#/components/responses/histogram"}}}},"/{catalog}/attachment/{field}/{id}":{"get":{"summary":"Download a row attachment","operationId":"attachment","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"description":"field name of attachment","in":"path","name":"field","required":true,"schema":{"$ref":"#/components/schemas/FieldName"}},{"description":"_id for row of interest","in":"path","name":"id","required":true,"schema":{"description":"field value","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/attachment"}}}},"/{catalog}/attachments/{format}":{"get":{"summary":"Download attachments in bulk from matching rows for multiple fields","operationId":"attachments","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["zip","uris","sh"],"type":"string"}},{"$ref":"#/components/parameters/filters"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/attachments"}}},"post":{"summary":"Download attachments in bulk from matching rows for multiple fields","operationId":"attachmentsPOST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["zip","uris","sh"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"},{"description":"attachments to return; use fields parameter to specify which attachments to include, and filter to select which rows","properties":{"fields":{"$ref":"#/components/schemas/FieldList"}},"required":["fields"],"type":"object"}],"title":"attachments request"}}}},"responses":{"200":{"$ref":"#/components/responses/attachments"}}}},"/{catalog}/attachments/{format}/{field}":{"get":{"summary":"Download attachments in bulk from matching rows for single field","operationId":"attachments1","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["zip","uris","sh"],"type":"string"}},{"in":"path","name":"field","required":true,"schema":{"$ref":"#/components/schemas/FieldName"}},{"$ref":"#/components/parameters/filters"}],"responses":{"200":{"$ref":"#/components/responses/attachments1"}}},"post":{"summary":"Download attachments in bulk from matching rows for single field","operationId":"attachments1POST","parameters":[{"description":"catalog name from list of catalogs","in":"path","name":"catalog","required":true,"schema":{"description":"catalog name","type":"string"}},{"in":"path","name":"format","required":true,"schema":{"enum":["zip","uris","sh"],"type":"string"}},{"in":"path","name":"field","required":true,"schema":{"$ref":"#/components/schemas/FieldName"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Filters"}],"title":"attachments1 request"}}}},"responses":{"200":{"$ref":"#/components/responses/attachments1"}}}}},"components":{"schemas":{"CatalogMeta":{"description":"High-level metadata for a dataset catalog","properties":{"descr":{"description":"long description in html","type":"string"},"name":{"description":"globally unique catalog name used in urls","type":"string"},"synopsis":{"description":"short description in plain text","type":"string"},"title":{"description":"display name","type":"string"}},"required":["name","title"],"title":"catalog metadata","type":"object"},"FieldValueScalar":{"anyOf":[{"format":"double","title":"double","type":"number"},{"format":"float","title":"float","type":"number"},{"format":"float","title":"half_float","type":"number"},{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"title":"long","type":"integer"},{"format":"int64","maximum":18446744073709551615,"minimum":0,"title":"unsigned_long","type":"integer"},{"format":"int32","maximum":2147483647,"minimum":-2147483648,"title":"integer","type":"integer"},{"maximum":32767,"minimum":-32768,"title":"short","type":"integer"},{"maximum":127,"minimum":-128,"title":"byte","type":"integer"},{"title":"boolean","type":"boolean"},{"title":"keyword","type":"string"}],"description":"a scalar value for a field","title":"scalar value"},"FieldValue":{"anyOf":[{"$ref":"#/components/schemas/FieldValueScalar"},{"items":{"$ref":"#/components/schemas/FieldValueScalar"},"title":"array","type":"array"}],"description":"a value for a field, which must match the type of the field","title":"field value"},"FieldStats":{"description":"stats for the field named by the property, depending on its type","oneOf":[{"additionalProperties":false,"description":"for numeric fields","properties":{"avg":{"description":"mean value","nullable":true,"type":"number"},"count":{"description":"number of rows with values for this field","maximum":18446744073709551615,"minimum":0,"type":"integer"},"max":{"description":"maximum value","nullable":true,"type":"number"},"min":{"description":"minimum value","nullable":true,"type":"number"}},"required":["count","min","max","avg"],"title":"numeric stats","type":"object"},{"additionalProperties":false,"description":"for non-numeric fields or those with terms=true","properties":{"others":{"description":"number of rows with values not included in the top terms","maximum":18446744073709551615,"minimum":0,"type":"integer"},"terms":{"description":"top terms in descending order of count","items":{"additionalProperties":false,"description":"unique field value","properties":{"count":{"description":"number of rows with this value","maximum":18446744073709551615,"minimum":0,"type":"integer"},"value":{"$ref":"#/components/schemas/FieldValue"}},"required":["value","count"],"title":"top term","type":"object"},"title":"top terms","type":"array","uniqueItems":true}},"required":["terms","others"],"type":"object"}],"title":"field stats"},"Type":{"description":"storage type","enum":["double","float","half_float","long","unsigned_long","integer","short","byte","boolean","keyword","array double","array float","array half_float","array long","array unsigned_long","array integer","array short","array byte","array boolean","array keyword"],"title":"field type","type":"string"},"FieldGroup":{"additionalProperties":false,"description":"A single field within a catalog, or a hiearchical group of fields","properties":{"attachment":{"description":"this is a meta field for a downloadable attachment (type boolean, indicating presence)","type":"boolean"},"base":{"description":"base storage type (floating, integral, boolean, string, void) for base scalar values of this field","enum":["f","i","b","s","v"],"type":"string"},"condition":{"additionalProperties":{"$ref":"#/components/schemas/FieldValue"},"description":"this field is only available if some other fields have specific values","type":"object"},"default":{"$ref":"#/components/schemas/FieldValue"},"descr":{"description":"description of field within the group","type":"string"},"dict":{"description":"unique key index to global field dictionary (for compare)","type":"string"},"disp":{"description":"include field in data display by default","type":"boolean"},"dtype":{"description":"numpy dtype for base scalar values of this field","type":"string"},"enum":{"description":"if present, display values as these keywords instead (integral or boolean: enum[<int>value])","items":{"type":"string"},"type":"array"},"name":{"description":"global unique (\"variable\") name of field within the catalog","type":"string"},"required":{"description":"true = required field (field you should filter on first to select data sub-set); false = top-level optional field (field that you likely want to filter on by default); missing = normal","type":"boolean"},"reversed":{"description":"display axes and ranges in reverse (high-low)","type":"boolean"},"scale":{"description":"scale factor to dict-comparable units, display  value*scale (for compare)","type":"number"},"stats":{"$ref":"#/components/schemas/FieldStats"},"store":{"description":"true if this field is stored but not indexed, so not permitted for filtering or aggregations","type":"boolean"},"sub":{"description":"if this is present, this is a pseudo grouping field which does not exist itself, but its properties apply to its children","items":{"$ref":"#/components/schemas/FieldGroup"},"title":"child fields","type":"array"},"terms":{"description":"display dynamically as a dropdown of values","type":"boolean"},"title":{"description":"display name of the field within the group","type":"string"},"type":{"$ref":"#/components/schemas/Type"},"units":{"description":"display units","type":"string"},"wildcard":{"description":"allow wildcard prefix searching on keyword field (\"xy*\")","type":"boolean"}},"required":["name","title","type","base","dtype"],"title":"field","type":"object"},"Filters":{"additionalProperties":{"description":"filter for a named field to be equal to a specific value or match other contraints","oneOf":[{"$ref":"#/components/schemas/FieldValue"},{"description":"equal to any of these values (not supported when used as a query parameter)","items":{"$ref":"#/components/schemas/FieldValue"},"minItems":1,"title":"filter equal","type":"array","uniqueItems":true},{"additionalProperties":false,"description":"in a bounded range for numeric fields: >= gte and <= lte, either of which may be omitted (when used as a query parameter, may be a string containing two FieldValues (either of which may be blank) separated by a single comma or space); omitting both is useful for filtering out missing values","properties":{"gte":{"$ref":"#/components/schemas/FieldValue"},"lte":{"$ref":"#/components/schemas/FieldValue"}},"title":"filter range","type":"object"},{"additionalProperties":false,"description":"matching a pattern for wildcard fields","properties":{"wildcard":{"description":"a pattern containing '*' and/or '?'","type":"string"}},"required":["wildcard"],"title":"filter wildcard","type":"object"}],"title":"field filter"},"description":"filters to apply to a query","properties":{"sample":{"default":1,"description":"randomly select a fractional sample","exclusiveMaximum":false,"exclusiveMinimum":true,"format":"double","maximum":1,"minimum":0,"type":"number"},"seed":{"default":0,"description":"seed for random sample selection","maximum":18446744073709551615,"minimum":0,"type":"integer"}},"type":"object"},"FieldName":{"description":"field name in selected catalog","title":"field name","type":"string"},"FieldList":{"items":{"$ref":"#/components/schemas/FieldName"},"title":"field list","type":"array","uniqueItems":true},"sort":{"items":{"description":"fields by which to sort row data","oneOf":[{"$ref":"#/components/schemas/FieldName"},{"additionalProperties":false,"description":"a field and an order to sort in (as a query parameter, field names may be prefixed by '+' (asc) or '-' (desc) instead)","properties":{"field":{"$ref":"#/components/schemas/FieldName"},"order":{"default":"asc","description":"ascending smallest to largest, or descending largest to smallest","enum":["asc","desc"],"pattern":"^[ad]*","title":"sort ordering","type":"string"}},"required":["field"],"title":"sort descriptor","type":"object"}],"title":"sort field","uniqueItems":true},"title":"sort","type":"array"},"data":{"description":"result data in the format requested, representing an array (over rows) of arrays (over values); in some formats the first row may be a list of field names","items":{"description":"a single data row corresponding to the requested fields in order (missing values are null)","items":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldValue"}]},"title":"data row","type":"array"},"title":"data result","type":"array"},"Histogram":{"oneOf":[{"$ref":"#/components/schemas/FieldName"},{"additionalProperties":false,"description":"parameters for a single-field histogram (when used as a query parameter, may be specified as \"FIELD:[log]SIZE\"); it's recommended to include fully-bounded range filters for any histogram fields","properties":{"field":{"$ref":"#/components/schemas/FieldName"},"log":{"default":false,"description":"whether to calculate the histogram using log-spaced buckets (rather than linear spacing)","title":"histogram scale","type":"boolean"},"size":{"default":16,"description":"number of buckets to include in the histogram","maximum":4096,"minimum":0,"title":"histogram size","type":"integer"}},"required":["field"],"title":"histogram desc","type":"object"}],"title":"histogram field"},"HistogramList":{"oneOf":[{"$ref":"#/components/schemas/Histogram"},{"description":"fields (dimensions or axes) along which to calculate a histogram, where each bucket will represent an intersection of all the fields and count of rows in that box, as calculated by the nested conditional histograms of inner (later) fields within outer (earlier) histograms","items":{"$ref":"#/components/schemas/Histogram"},"maxItems":3,"minItems":1,"type":"array","uniqueItems":true}],"title":"histogram fields"}},"responses":{"top":{"description":"top result","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CatalogMeta"},"title":"top result","type":"array"}}}},"catalog":{"description":"catalog result","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CatalogMeta"},{"description":"full catalog metadata","properties":{"count":{"description":"total number of rows","maximum":18446744073709551615,"minimum":0,"type":"integer"},"fields":{"items":{"$ref":"#/components/schemas/FieldGroup"},"title":"field groups","type":"array"},"sort":{"description":"default sort fields","items":{"type":"string"},"type":"array"}},"required":["fields","count"],"title":"catalog info","type":"object"}],"title":"catalog result"}}}},"schema.sql":{"description":"schema.sql result","content":{"application/sql":{"schema":{"description":"CREATE TABLE SQL schema"}}}},"schema.csv":{"description":"schema.csv result","content":{"text/csv":{"schema":{"description":"CSV representation of catalog fields"}}}},"data":{"description":"selected data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data"}}}},"download":{"description":"file containing all matching content in the selected format","content":{"application/x-npy":{"schema":{"description":"Numpy binary array file containing a 1-d array of structured data types representing the fields in each row; missing values are generally represented by NaN or extreme values","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"npy data"}},"text/x-ecsv":{"schema":{"description":"Enhanced CSV file as per https://github.com/astropy/astropy-APEs/blob/main/APE6.rst, with a YAML header followed by a standard CSV file","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"ecsv data"}},"application/json":{"schema":{"description":"JSON array data, where the first element is an array of field names and subsequent elements are arrays of values in the same order","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"json data"}},"application/fits":{"schema":{"description":"FITS BINTABLE binary table file containing the requested fields","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"fits data"}},"text/csv":{"schema":{"description":"Standard CSV file with a header of field names; missing values are represented by empty fields, arrays are encoded as JSON","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"csv data"}},"application/x-ndjson":{"schema":{"description":"Newline-delimited JSON data, where each line is an object of field values","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"ndjson data"}},"application/gzip":{"schema":{"description":"compressed version of the selected format","oneOf":[{"$ref":"#/components/schemas/data"}],"title":"gzip data"}}}},"count":{"description":"count result","content":{"application/json":{"schema":{"description":"number of matching rows","maximum":18446744073709551615,"minimum":0,"title":"stats result","type":"integer"}}}},"stats":{"description":"stats result","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/FieldStats"},"description":"stats","title":"stats result","type":"object"}}}},"histogram":{"description":"histogram result","content":{"application/json":{"schema":{"additionalProperties":false,"description":"histogram result","properties":{"buckets":{"items":{"additionalProperties":false,"description":"histogram bucket, representing a box in the dimension space specified by the requested fields","properties":{"count":{"description":"the number of rows with values that fall within this bucket","maximum":18446744073709551615,"minimum":0,"type":"integer"},"key":{"description":"the minimum (left) point of this bucket, such than the bucket includes the range [key,key+size) (or [key,key*size) for log scale)","items":{"$ref":"#/components/schemas/FieldValue"},"type":"array"},"quartiles":{"description":"if quartiles of a field were requested, includes the values of that field corresponding to the [0,25,50,75,100] percentiles ([min, first quartile, median, third quartile, max]) for rows within this bucket","items":{"$ref":"#/components/schemas/FieldValue"},"type":"array"}},"required":["key","count"],"title":"bucket","type":"object"},"type":"array"},"sizes":{"description":"field order corresponds to the requested histogram fields and bucket keys","items":{"description":"size of each histogram buckets in this dimension, either as an absolute width in linear space, or as a ratio in log space","exclusiveMinimum":true,"minimum":0,"title":"bucket size","type":"number"},"title":"bucket dimensions","type":"array"}},"required":["sizes","buckets"],"title":"histogram result","type":"object"}}}},"attachment":{"description":"attachment result","content":{"application/octet-stream":{"schema":{"description":"attachment file (type depends on field)"}}}},"attachments":{"description":"file containing all matching attachments in the selected format","content":{"application/zip":{"schema":{"description":"A ZIP file containing all the selected attachments","title":"zip attachments"}},"text/uri-list":{"schema":{"description":"A text file listing all the URLs of the selected attachments, one per line, with a one line #comment header","title":"uris attachments"}},"text/x-shellscript":{"schema":{"description":"A text shell script that downloads all the selected attachments with curl -JO, one per line","title":"sh attachments"}}}},"attachments1":{"description":"file containing all matching attachments in the selected format","content":{"application/zip":{"schema":{"description":"A ZIP file containing all the selected attachments","title":"zip attachments"}},"text/uri-list":{"schema":{"description":"A text file listing all the URLs of the selected attachments, one per line, with a one line #comment header","title":"uris attachments"}},"text/x-shellscript":{"schema":{"description":"A text shell script that downloads all the selected attachments with curl -JO, one per line","title":"sh attachments"}}}}},"parameters":{"filters":{"name":"filters","description":"filter in query string (see descriptions for non-standard formatting of range queries)","in":"query","schema":{"$ref":"#/components/schemas/Filters"},"style":"form","explode":true},"fields":{"name":"fields","description":"list of fields to return","required":true,"in":"query","schema":{"$ref":"#/components/schemas/FieldList"},"style":"form","explode":false},"sort":{"name":"sort","description":"how to order rows (see descriptions for non-standard formatting of sort order)","in":"query","schema":{"$ref":"#/components/schemas/sort"},"style":"form","explode":false}}},"openapi":"3.0.0"}