{"endpoints":[{"identifier":"ws-gff3-query","minVersion":10,"methods":[{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for sequence\nannotations, and returning results in [GFF3](http://en.wikipedia.org/wiki/General_feature_format)\nformat. The user is responsible for\nensuring that the query contains only suitable types for export.\nA suitable query is one where every view column references a\nfield of a `SequenceFeature` (including all sub-classes). The\nparticular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/gff3","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"},{"Type":"String[]","Description":"Extra columns to include as extra information in the ninth column","Required":"N","Recommended":false,"Default":"Gene.length","Name":"view"}],"Synopsis":"Query the Database for Sequence Annotations."},{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for sequence\nannotations, and returning results in [GFF3](http://en.wikipedia.org/wiki/General_feature_format)\nformat. The user is responsible for\nensuring that the query contains only suitable types for export.\nA suitable query is one where every view column references a\nfield of a `SequenceFeature` (including all sub-classes). The\nparticular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/gff3","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"},{"Type":"String[]","Description":"Extra columns to include as extra information in the ninth column","Required":"N","Recommended":false,"Default":"Gene.length","Name":"view"}],"Synopsis":"Query the Database for Sequence Annotations."}],"name":"GFF3 Query Results","URI":"/service/query/results/gff3"},{"identifier":"ws-gff3-lists","minVersion":10,"methods":[{"DescriptionFormat":"markdown","Description":"This service allows users to export the contents of a list\nof `SequenceFeature`s as GFF3.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/list/results/gff3","parameters":[{"Options":"/lists|lists{status=CURRENT,type=Gene}","Type":"String","Description":"The name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"list"}],"Synopsis":"Get the Contents of a List as GFF3."},{"DescriptionFormat":"markdown","Description":"This service allows users to export the contents of a list\nof `SequenceFeature`s as GFF3.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/list/results/gff3","parameters":[{"Options":"/lists|lists{status=CURRENT,type=Gene}","Type":"String","Description":"The name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"list"}],"Synopsis":"Get the Contents of a List as GFF3."}],"name":"List as GFF3","URI":"/service/list/results/gff3"},{"identifier":"ws-fa-lists","minVersion":16,"methods":[{"DescriptionFormat":"markdown","Description":"This service allows users to export the contents of a list\nof `SequenceFeature`s or `Protein`s as\n[FASTA](http://en.wikipedia.org/wiki/FASTA_format)\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/list/results/fasta","parameters":[{"Options":"/lists|lists{status=CURRENT,type=Gene,type=Protein}","Type":"String","Description":"The name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"list"}],"Synopsis":"Get the Contents of a List as FASTA."},{"DescriptionFormat":"markdown","Description":"This service allows users to export the contents of a list\nof `SequenceFeature`s or `Protein`s as\n[FASTA](http://en.wikipedia.org/wiki/FASTA_format)\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/list/results/fasta","parameters":[{"Options":"/lists|lists{status=CURRENT,type=Gene,type=Protein}","Type":"String","Description":"The name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"list"}],"Synopsis":"Get the Contents of a List as FASTA."}],"name":"List as FASTA","URI":"/service/list/results/fasta"},{"identifier":"ws-fasta-query","minVersion":10,"methods":[{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for sequence,\nand returning results in [FASTA](http://en.wikipedia.org/wiki/FASTA_format)\nformat. The user is responsible for\nensuring that the query contains only suitable types for export.\n\nA suitable query is one with a single view column which references a\nfield of a `SequenceFeature` (including all sub-classes) or of a\na `Protein`. The particular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/fasta","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"},{"Type":"String[]","Description":"Extra columns to include as extra information in the ninth column","Required":"N","Recommended":false,"Default":"Gene.length","Name":"view"}],"Synopsis":"Query the Database for Sequence."},{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for sequence,\nand returning results in [FASTA](http://en.wikipedia.org/wiki/FASTA_format)\nformat. The user is responsible for\nensuring that the query contains only suitable types for export.\n\nA suitable query is one with a single view column which references a\nfield of a `SequenceFeature` (including all sub-classes) or of a\na `Protein`. The particular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/fasta","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"},{"Type":"String[]","Description":"Extra columns to include as extra information in the ninth column","Required":"N","Recommended":false,"Default":"Gene.length","Name":"view"}],"Synopsis":"Query the Database for Sequence."}],"name":"FASTA Query Results","URI":"/service/query/results/fasta"},{"identifier":"ws-bed-query","minVersion":10,"methods":[{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for genomic locations,\nand returning results in [UCSC BED](http://genome.ucsc.edu/FAQ/FAQformat.html) format.\nThe user is responsible for ensuring that the query contains only suitable types for export.\n\nA suitable query is one where every view column references a\nfield of a `SequenceFeature` (including all sub-classes).\nThe particular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/bed","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"}],"Synopsis":"Query the Database for Locations."},{"DescriptionFormat":"markdown","Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML or JSON format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML and JSON\nsyntax.\n\nThis endpoint specialises in dealing with queries for genomic locations,\nand returning results in [UCSC BED](http://genome.ucsc.edu/FAQ/FAQformat.html) format.\nThe user is responsible for ensuring that the query contains only suitable types for export.\n\nA suitable query is one where every view column references a\nfield of a `SequenceFeature` (including all sub-classes).\nThe particular field selected is not important, and the object itself\nwill be selected.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results/bed","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"\n \n \n<\/query>","Name":"query"}],"Synopsis":"Query the Database for Locations."}],"name":"BED Query Results","URI":"/service/query/results/bed"},{"identifier":"ws-genomic-region-to-list","minVersion":8,"methods":[{"DescriptionFormat":"markdown","Description":"This service creates a list of features found\noverlapping a set of genomic intervals. All features\nfound will be saved in a list of the given name. The type of this\nlist will be inferred from the types provided in the search input.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"GET","RequiresAuthentication":"true","URI":"/regions/list","parameters":[{"Type":"String","Description":"The name of the list to save these features to","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String","Description":"An optional description for this list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to this list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"JSON","Description":"The region search input","Required":"Y","Recommended":false,"Default":" {\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n }\n ","Name":"query"}],"Synopsis":"Create a New List from Features found in Genomic Intervals"},{"DescriptionFormat":"markdown","Description":"This service creates a list of features found\noverlapping a set of genomic intervals. All features\nfound will be saved in a list of the given name. The type of this\nlist will be inferred from the types provided in the search input.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"POST","RequiresAuthentication":"true","bodyDescription":"A representation of the search request.","body":[{"schema":"/schema/region-search-request.schema","contentType":"application/json","example":"{\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n}\n "}],"URI":"/regions/list","parameters":[{"Type":"String","Description":"The name of the list to save these features to","Required":"Y","Recommended":false,"Name":"listName"},{"Type":"String","Description":"An optional description for this list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to this list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"}],"Synopsis":"Create a New List from Features found in Genomic Intervals"}],"name":"Create List from Genomic Intervals","URI":"/service/regions/list"},{"identifier":"ws-genomic-region-to-gff3","minVersion":8,"methods":[{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the General Feature Format\n[GFF3](http://en.wikipedia.org/wiki/General_feature_format)\nwhere each row represents a feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"GET","RequiresAuthentication":"false","URI":"/regions/gff3","parameters":[{"Type":"JSON","Description":"The region search input","Required":"Y","Recommended":false,"Default":" {\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n }\n ","Name":"query"}],"Synopsis":"Get Genomic Features overlapping given Regions"},{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the General Feature Format\n[GFF3](http://en.wikipedia.org/wiki/General_feature_format)\nwhere each row represents a feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"POST","RequiresAuthentication":"false","bodyDescription":"A representation of the search request.","body":[{"schema":"/schema/region-search-request.schema","contentType":"application/json","example":"{\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n}\n "}],"URI":"/regions/gff3","parameters":[],"Synopsis":"Get Genomic Features overlapping given Regions"}],"name":"Genomic Intervals as GFF3","URI":"/service/regions/gff3"},{"identifier":"ws-genomic-region-to-fasta","minVersion":8,"methods":[{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the\n[FASTA](http://en.wikipedia.org/wiki/FASTA_format) format\nwhere each record represents a feature, including the sequence\nassociated with that feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"GET","RequiresAuthentication":"false","URI":"/regions/sequence","parameters":[{"Type":"JSON","Description":"The region search input","Required":"Y","Recommended":false,"Default":" {\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n }\n ","Name":"query"}],"Synopsis":"Get Genomic Features overlapping given Regions"},{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the\n[FASTA](http://en.wikipedia.org/wiki/FASTA_format) format\nwhere each record represents a feature, including the sequence\nassociated with that feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"POST","RequiresAuthentication":"false","bodyDescription":"A representation of the search request.","body":[{"schema":"/schema/region-search-request.schema","contentType":"application/json","example":"{\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n}\n "}],"URI":"/regions/sequence","parameters":[],"Synopsis":"Get Genomic Features overlapping given Regions"}],"name":"Genomic Intervals as FASTA","URI":"/service/regions/sequence"},{"identifier":"ws-genomic-region-to-bed","minVersion":8,"methods":[{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the [UCSC BED](http://genome.ucsc.edu/FAQ/FAQformat.html) format\nwhere each row represents a feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"GET","RequiresAuthentication":"false","URI":"/regions/bed","parameters":[{"Type":"JSON","Description":"The region search input","Required":"Y","Recommended":false,"Default":" {\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n }\n ","Name":"query"}],"Synopsis":"Get Genomic Features overlapping given Regions"},{"DescriptionFormat":"markdown","Description":"This service returns information about features found\noverlapping a set of genomic intervals. The results are\nreturned in the [UCSC BED](http://genome.ucsc.edu/FAQ/FAQformat.html) format\nwhere each row represents a feature.\n\nThe input to this service is a `json` object that satisfies the\nfollowing [json-schema](http://json-schema.org/) schema:\n\n```\n{\n \"type\": \"object\",\n \"required\": [\"regions\", \"featureTypes\", \"organism\"],\n \"properties\": {\n \"regions\": \"#/definitions/stringset\",\n \"featureTypes\": \"#/definitions/stringset\",\n \"isInterbase\": { \"type\": \"boolean\" },\n \"extension\": { \"type\": \"number\" },\n \"organism\": { \"type\": \"string\" }\n },\n \"definitions\": {\n \"stringset\": {\n \"type\": \"array\",\n \"items: { \"type: \"string\" },\n \"minItems\": 1,\n \"uniqueItems\": true\n }\n }\n}\n```\n ","HTTPMethod":"POST","RequiresAuthentication":"false","bodyDescription":"A representation of the search request.","body":[{"schema":"/schema/region-search-request.schema","contentType":"application/json","example":"{\n \"regions\": [\n \"2L:14615455..14619002\",\n \"2R:5866646..5868384\",\n \"3R:2578486..2580016\"\n ],\n \"featureTypes\": [\"Gene\", \"Exon\", \"Intron\"],\n \"organism\": \"D. melanogaster\"\n}\n "}],"URI":"/regions/bed","parameters":[],"Synopsis":"Get Genomic Features overlapping given Regions"}],"name":"Genomic Intervals as BED","URI":"/service/regions/bed"},{"identifier":"ws-external-links","minVersion":31,"methods":[{"DescriptionFormat":"markdown","Description":"This service provides a list of external links given the id of the intermine object.\nUsed for the report page.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/elinks","parameters":[{"Type":"String","Description":"InterMine objectId","Required":"Y","Recommended":false,"Default":"100011001","Name":"id"}],"Synopsis":"External links for intermine object."},{"DescriptionFormat":"markdown","Description":"This service provides a list of external links given the id of the intermine object.\nUsed for the report page.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/elinks","parameters":[{"Type":"String","Description":"InterMine objectId","Required":"Y","Recommended":false,"Default":"100011001","Name":"id"}],"Synopsis":"External links for intermine object."}],"name":"External links","URI":"/service/elinks"},{"identifier":"ws-query-results","minVersion":1,"methods":[{"Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML\nsyntax.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results","parameters":[{"Type":"XML","Description":"A definition of the query to execute in Path-Query XML format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"{ \"from\": \"Gene\", \"select\": [ \"secondaryIdentifier\", \"symbol\", \"primaryIdentifier\", \"organism.name\" ], \"orderBy\": [ { \"path\": \"secondaryIdentifier\", \"direction\": \"ASC\" } ], \"where\": [ { \"path\": \"organism.name\", \"op\": \"=\", \"value\": \"Drosophila melanogaster\", \"code\": \"A\" } ] }\"","Name":"query"},{"Type":"Integer","Description":"The version of the XML format used","Required":"N","Recommended":false,"Default":"2","Name":"version"},{"Type":"Integer","Description":"The index of the first result to return.","Required":"N","Recommended":false,"Default":"0","Name":"start"},{"Type":"Integer","Description":"The maximum size of the result set.","Required":"N","Recommended":true,"Default":"10","Name":"size"},{"Type":"enumerated","Description":"Include column headers. Use friendly for human readable paths. (Only for flat-file formats)","Required":"N","Recommended":false,"EnumeratedList":["none","path","friendly"],"Default":"none","Name":"columnheaders"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["tab","csv","count","json","jsonobjects","jsoncount","xml","html","rdf+xml"],"Default":"tab","Name":"format"}],"Synopsis":"Get results for a query against the database.","returnFormats":[{"accept":"application/tsv","Name":"tab"},{"accept":"application/csv","Name":"csv"},{"accept":"text/count","Name":"count"},{"key":"results","accept":"application/json","Name":"json"},{"key":"results","accept":"application/json;type=objects","Name":"jsonobjects"},{"key":"results","accept":"application/json;type=count","Name":"jsoncount"},{"accept":"application/xml","Name":"xml"},{"accept":"text/html","Name":"html"},{"accept":"application/rdf+xml","Name":"rdf+xml"}]},{"Description":"This service provides full access to arbitrary database queries.\nQueries are accepted in a serialised XML format, executed and returned\nin a streaming manner. The query format is a custom subset of the capabilities\nof SQL; see the InterMine documentation for a full description of the query XML\nsyntax.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"GET","URI":"/query/results","parameters":[{"Type":"XML","Description":"A definition of the query to execute in Path-Query XML format","Required":"Y","Recommended":false,"Schema":"/schema/query.xsd","Default":"{ \"from\": \"Gene\", \"select\": [ \"secondaryIdentifier\", \"symbol\", \"primaryIdentifier\", \"organism.name\" ], \"orderBy\": [ { \"path\": \"secondaryIdentifier\", \"direction\": \"ASC\" } ], \"where\": [ { \"path\": \"organism.name\", \"op\": \"=\", \"value\": \"Drosophila melanogaster\", \"code\": \"A\" } ] }\"","Name":"query"},{"Type":"Integer","Description":"The version of the XML format used","Required":"N","Recommended":false,"Default":"2","Name":"version"},{"Type":"Integer","Description":"The index of the first result to return.","Required":"N","Recommended":false,"Default":"0","Name":"start"},{"Type":"Integer","Description":"The maximum size of the result set.","Required":"N","Recommended":true,"Default":"10","Name":"size"},{"Type":"enumerated","Description":"Include column headers. Use friendly for human readable paths. (Only for flat-file formats)","Required":"N","Recommended":false,"EnumeratedList":["none","path","friendly"],"Default":"none","Name":"columnheaders"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["tab","csv","count","json","jsonobjects","jsoncount","xml","html","rdf+xml"],"Default":"tab","Name":"format"}],"Synopsis":"Get results for a query against the database.","returnFormats":[{"accept":"application/tsv","Name":"tab"},{"accept":"application/csv","Name":"csv"},{"accept":"text/count","Name":"count"},{"key":"results","accept":"application/json","Name":"json"},{"key":"results","accept":"application/json;type=objects","Name":"jsonobjects"},{"key":"results","accept":"application/json;type=count","Name":"jsoncount"},{"accept":"application/xml","Name":"xml"},{"accept":"text/html","Name":"html"},{"accept":"application/rdf+xml","Name":"rdf+xml"}]}],"name":"Query Results","URI":"/service/query/results"},{"identifier":"ws-query-to-list","minVersion":4,"methods":[{"DescriptionFormat":"markdown","Description":"This service provides the facility to submit a query and create a new list\nwhose contents shall be the result set defined by running the query.\n\nThis facility places a couple of restrictions on the query itself, namely that\nthe view list may only contain a single item, which can refer to any attribute\nof an object. The attribute itself will be ignored, and the object itself\nwill be selected. For this reason, one might choose to always select the `.id`\nattribute when using this service.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/tolist","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Name":"query"},{"Type":"String","Description":"The name for the new list. There must be no existing list of this name","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String","Description":"A description to attach to the new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Save the result set of a query as a list on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"DescriptionFormat":"markdown","Description":"This service provides the facility to submit a query and create a new list\nwhose contents shall be the result set defined by running the query.\n\nThis facility places a couple of restrictions on the query itself, namely that\nthe view list may only contain a single item, which can refer to any attribute\nof an object. The attribute itself will be ignored, and the object itself\nwill be selected. For this reason, one might choose to always select the `.id`\nattribute when using this service.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/tolist","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format","Required":"Y","Recommended":false,"Name":"query"},{"Type":"String","Description":"The name for the new list. There must be no existing list of this name","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String","Description":"A description to attach to the new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Save the result set of a query as a list on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Create List from Query","URI":"/service/query/tolist"},{"identifier":"ws-query-append","minVersion":4,"methods":[{"Description":"This service provides the facility to submit a query and add the objects\ncontained in its result set to a list that already exists on the server. This\nfacility places a couple of restrictions on the query itself, namely that\nthe view list may only contain a single item, which should refer to the\ninternal id attribute of an object in the query.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/append/tolist","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"String","Description":"The list to append items to.","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Add the result set of a query to a list on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service provides the facility to submit a query and add the objects\ncontained in its result set to a list that already exists on the server. This\nfacility places a couple of restrictions on the query itself, namely that\nthe view list may only contain a single item, which should refer to the\ninternal id attribute of an object in the query.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/append/tolist","parameters":[{"Type":"String","Description":"A definition of the query to execute in Path-Query XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"String","Description":"The list to append items to.","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Add the result set of a query to a list on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Add to List from Query","URI":"/service/query/append/tolist"},{"identifier":"ws-query-upload","minVersion":4,"methods":[{"Description":"This service provides the facility to submit one or more queries\nand save it/them for future reference to a user account on the server.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/upload","parameters":[{"Type":"String","Description":"A definition of the query/ies to save in Path-Query XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"Integer","Description":"The version of the path-qeury format being used.","Required":"N","Recommended":false,"Name":"version"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Save queries to a user account on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service provides the facility to submit one or more queries\nand save it/them for future reference to a user account on the server.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/query/upload","parameters":[{"Type":"String","Description":"A definition of the query/ies to save in Path-Query XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"Integer","Description":"The version of the path-qeury format being used.","Required":"N","Recommended":false,"Name":"version"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Save queries to a user account on the server.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Save Query","URI":"/service/query/upload"},{"identifier":"ws-lists","minVersion":1,"methods":[{"Description":"This service allows users to get back a list of\nlists that contain a given object, either defined by an\ninternal ID, or looked up from stable identifiers.\nIf the request does not authenticate to a user account,\nthen only relevant public lists will be returned.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"GET","URI":"/listswithobject","parameters":[{"Type":"String","Description":"A stable identifier that can be used to find the object.","Required":"N","Recommended":false,"Name":"publicId"},{"Type":"Integer","Description":"The internal DB id (changes on each re-release).","Required":"N","Recommended":false,"Name":"id"},{"Options":"/model|model.classes","Type":"String","Description":"The type of object (required if using a public id)","Required":"N","Recommended":false,"Default":"{name}","Name":"type"},{"Type":"String","Description":"An extra value to disambiguate objects","Required":"N","Recommended":false,"Name":"extraValue"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","html","text","csv","tab"],"Default":"json","Name":"format"}],"Synopsis":"Find lists on the server containing an object.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/html","Name":"html"},{"accept":"text/plain","Name":"text"},{"accept":"application/csv","Name":"csv"},{"accept":"application/tsv","Name":"tab"}]},{"Description":"This service allows users to get back a list of\nlists that contain a given object, either defined by an\ninternal ID, or looked up from stable identifiers.\nIf the request does not authenticate to a user account,\nthen only relevant public lists will be returned.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"GET","URI":"/listswithobject","parameters":[{"Type":"String","Description":"A stable identifier that can be used to find the object.","Required":"N","Recommended":false,"Name":"publicId"},{"Type":"Integer","Description":"The internal DB id (changes on each re-release).","Required":"N","Recommended":false,"Name":"id"},{"Options":"/model|model.classes","Type":"String","Description":"The type of object (required if using a public id)","Required":"N","Recommended":false,"Default":"{name}","Name":"type"},{"Type":"String","Description":"An extra value to disambiguate objects","Required":"N","Recommended":false,"Name":"extraValue"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","html","text","csv","tab"],"Default":"json","Name":"format"}],"Synopsis":"Find lists on the server containing an object.","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/html","Name":"html"},{"accept":"text/plain","Name":"text"},{"accept":"application/csv","Name":"csv"},{"accept":"application/tsv","Name":"tab"}]}],"name":"Find Lists Containing an Object","URI":"/service/listswithobject"},{"identifier":"ws-list-append","minVersion":4,"methods":[{"Description":"This service allows users to add new items to an existing\nlist by uploading a set of identifiers. This is equivalent to\ncreating a new list from a set of identifiers, and then performing\nthe union operation on that list an existing one, if the resulant\nlist replaced the existing list.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","bodyDescription":"Identifiers for objects to add to the list, tab, comma or newline separated.","body":[{"contentType":"text/plain","example":"\"even skipped\"\nzen, bib\nhairless\n "}],"URI":"/lists/append","parameters":[{"Options":"/lists|lists{authorized,status=CURRENT}","Type":"String","Description":"The name of the list to append to. The list must exist, and belong to you.","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Add items to an existing list by identifiers","returnFormats":[{"key":"list","accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Append to List","URI":"/service/lists/append"},{"identifier":"ws-list-union","minVersion":4,"methods":[{"Description":"This service allows users to create new lists which contain all the members\ncontained in the set of input lists. The user must have access to all the input\nlists, but need not be the owner of any of them. A union of a single list with\nitself may be considered a copy.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","MethodName":"Combine Lists","URI":"/lists/union","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list.","Required":"Y","Recommended":false,"Default":"{name}","Name":"lists"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Combine Two or More Lists through Union","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service allows users to create new lists which contain all the members\ncontained in the set of input lists. The user must have access to all the input\nlists, but need not be the owner of any of them. A union of a single list with\nitself may be considered a copy.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","MethodName":"Combine Lists","URI":"/lists/union","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list.","Required":"Y","Recommended":false,"Default":"{name}","Name":"lists"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Combine Two or More Lists through Union","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"List Union","URI":"/service/lists/union"},{"identifier":"ws-list-subtract","minVersion":4,"methods":[{"Description":"This service allows users to create new lists which contain only those elements\nwhich are present in one set of lists, and none of those elements which are present\nin another set of lists. This is what is typically thought of as subtraction, or more\ntechnically, the asymmetric difference of two sets. The user must supply the names of\nthe lists to be used as either the source lists or the subtraction lists, as well as\ndetails for the new list to be created. The user must have access to all the named lists,\nbut need not be the owner of any of them.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/lists/subtract","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list","Required":"Y","Recommended":false,"Default":"{name}","Name":"references"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a list to exclude","Required":"Y","Recommended":false,"Default":"{name}","Name":"subtract"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Subtract one List From Another","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service allows users to create new lists which contain only those elements\nwhich are present in one set of lists, and none of those elements which are present\nin another set of lists. This is what is typically thought of as subtraction, or more\ntechnically, the asymmetric difference of two sets. The user must supply the names of\nthe lists to be used as either the source lists or the subtraction lists, as well as\ndetails for the new list to be created. The user must have access to all the named lists,\nbut need not be the owner of any of them.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/lists/subtract","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list","Required":"Y","Recommended":false,"Default":"{name}","Name":"references"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a list to exclude","Required":"Y","Recommended":false,"Default":"{name}","Name":"subtract"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Subtract one List From Another","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"List Subtraction","URI":"/service/lists/subtract"},{"identifier":"ws-list-intersect","minVersion":4,"methods":[{"Description":"This service allows users to create new lists which contain only those items\nwhich are members of all the source lists. The user must have access to all the input\nlists, but need not be the owner of any of them. An intersection of a single list\nmay be considered a copy.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","MethodName":"Intersect Lists","URI":"/lists/intersect","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list, or multiple list names concatenated with a ';' separator.","Required":"Y","Recommended":false,"Default":"{name}","Name":"lists"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Combine Two or More Lists through Intersection","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"List Intersection","URI":"/service/lists/intersect"},{"identifier":"ws-list-diff","minVersion":4,"methods":[{"Description":"This service allows users to create new lists which only contain members which are not shared\nby an even number of lists (see: http://en.wikipedia.org/wiki/Symmetric_difference).\nThe user must have access to all the input lists, but need not be the owner of any of them.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","MethodName":"Symmetric Difference","URI":"/lists/diff","parameters":[{"Type":"String","Description":"The name of the list to create","Required":"Y","Recommended":false,"Name":"name"},{"Options":"/lists|lists{status=CURRENT}","Type":"String[]","Description":"The name of a source list","Required":"Y","Recommended":false,"Default":"{name}","Name":"lists"},{"Type":"String","Description":"A description of this new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to apply to the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Combine Two or More Lists through Difference","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"List Difference","URI":"/service/lists/diff"},{"identifier":"ws-available-lists","minVersion":4,"methods":[{"Description":"This service allows users to get back a list of\nlists that they have access to. The lists can be optionally\nbe filtered on the server by name, thus returning just a single\nname, or if '*' wildcards are used, a subset of all lists.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","URI":"/lists","parameters":[{"Type":"String","Description":"An optional filter by name.","Required":"N","Recommended":false,"Name":"name"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","html","text","csv","tab"],"Default":"json","Name":"format"}],"Synopsis":"Find lists on the server.","returnFormats":[{"key":"lists","accept":"application/json","Name":"json"},{"accept":"text/html","Name":"html"},{"accept":"text/plain","Name":"text"},{"accept":"application/csv","Name":"csv"},{"accept":"application/tsv","Name":"tab"}]},{"Description":"This service allows users to delete\nlists that belong to them.\n ","HTTPMethod":"DELETE","RequiresAuthentication":"true","URI":"/lists","parameters":[{"Options":"/lists|lists{authorized}","Type":"String","Description":"The name of the list to delete","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Delete an existing list","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service allows users to create a new\nlist by uploading a set of identifiers.\n The list is created by using the default settings\n of the ID resolution mechanism and then taking\n all the good matches.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","bodyDescription":"Identifiers for objects to add to the list, tab, comma or newline separated.","body":[{"contentType":"text/plain","example":"\"even skipped\"\nzen, bib\nhairless\n "}],"URI":"/lists","parameters":[{"Type":"String","Description":"The name of the new list","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String","Description":"The description of the new list","Required":"N","Recommended":false,"Name":"description"},{"Options":"/model|model.classes","Type":"String","Description":"The type of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"type"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"String","Description":"A disambiguating value (such as organism name)","Required":"N","Recommended":false,"Name":"extraValue"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Create a new list","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"Description":"This service allows users to updated the\ndescription of lists belonging to them.\n ","HTTPMethod":"PUT","RequiresAuthentication":"true","URI":"/lists","parameters":[{"Type":"String","Description":"The name of the list","Required":"Y","Recommended":false,"Name":"name"},{"Type":"String","Description":"The new list's description","Required":"Y","Recommended":false,"Name":"newDescription"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Update the description of an existing list","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Lists","URI":"/service/lists"},{"identifier":"ws-rename-list","minVersion":4,"methods":[{"Description":"This service allows users to change the name of an existing list that\nthey are the owner of.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/lists/rename","parameters":[{"Options":"/lists|lists{authorized}","Type":"String","Description":"The current name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"oldname"},{"Type":"String","Description":"The name the list should have","Required":"Y","Recommended":false,"Name":"newname"}],"Synopsis":"Rename an Existing List","returnFormats":[{"accept":"application/json","Name":"json"}]},{"Description":"This service allows users to change the name of an existing list that\nthey are the owner of.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/lists/rename","parameters":[{"Options":"/lists|lists{authorized}","Type":"String","Description":"The current name of the list","Required":"Y","Recommended":false,"Default":"{name}","Name":"oldname"},{"Type":"String","Description":"The name the list should have","Required":"Y","Recommended":false,"Name":"newname"}],"Synopsis":"Rename an Existing List","returnFormats":[{"accept":"application/json","Name":"json"}]}],"name":"List Renaming","URI":"/service/lists/rename"},{"identifier":"ws-lists-jaccard-index","minVersion":30,"methods":[{"Description":"This service compares the named list with all available lists. (public lists and\nprivate ones if the user is logged in). Its returns the name of each list\ncompared plus a number representing the Jaccard Index. See https://en.wikipedia.org/wiki/Jaccard_index\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/lists/jaccard-index","parameters":[{"Options":"/lists|lists{authorized}","Type":"String","Description":"The name of the list","Required":"N","Recommended":false,"Default":"{name}","Name":"list"},{"Type":"String","Description":"The list of InterMine IDs","Required":"N","Recommended":false,"Name":"ids"},{"Type":"Float","Description":"If the Jaccard Index is lower than this value, discard","Required":"N","Recommended":false,"Default":"0.05","Name":"min"},{"Options":"/model|model.classes","Type":"String","Description":"The type of InterMine objects (if providing IDs)","Required":"N","Recommended":false,"Default":"{name}","Name":"type"}],"Synopsis":"Measure similarity of lists using Jaccard Index","returnFormats":[{"accept":"application/json","Name":"json"}]},{"Description":"This service compares the named list with all available lists. (public lists and\nprivate ones if the user is logged in). Its returns the name of each list\ncompared plus a number representing the Jaccard Index. See https://en.wikipedia.org/wiki/Jaccard_index\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/lists/jaccard-index","parameters":[{"Options":"/lists|lists{authorized}","Type":"String","Description":"The name of the list","Required":"N","Recommended":false,"Default":"{name}","Name":"list"},{"Type":"String","Description":"The list of InterMine IDs","Required":"N","Recommended":false,"Name":"ids"},{"Type":"Float","Description":"If the Jaccard Index is lower than this value, discard","Required":"N","Recommended":false,"Default":"0.05","Name":"min"},{"Options":"/model|model.classes","Type":"String","Description":"The type of InterMine objects (if providing IDs)","Required":"N","Recommended":false,"Default":"{name}","Name":"type"}],"Synopsis":"Measure similarity of lists using Jaccard Index","returnFormats":[{"accept":"application/json","Name":"json"}]}],"name":"Jaccard Index","URI":"/service/lists/jaccard-index"},{"identifier":"ws-template-upload","methods":[{"Description":"This service allows users to save templates they have authored on the server, associated\nwith their account. The templates once saved can be used as any other template query.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/template/upload","parameters":[{"Type":"String","Description":"One or more templates, serialised in XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"Integer","Description":"The version of the XML format","Required":"N","Recommended":false,"Default":"2","Name":"version"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["text","json","html","xml"],"Default":"text","Name":"format"}],"Synopsis":"Save a Template, or Overwrite an Existing One","returnFormats":[{"accept":"text/plain","Name":"text"},{"accept":"application/json","Name":"json"},{"accept":"text/html","Name":"html"},{"accept":"application/xml","Name":"xml"}]},{"Description":"This service allows users to save templates they have authored on the server, associated\nwith their account. The templates once saved can be used as any other template query.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/template/upload","parameters":[{"Type":"String","Description":"One or more templates, serialised in XML or JSON format.","Required":"Y","Recommended":false,"Name":"query"},{"Type":"Integer","Description":"The version of the XML format","Required":"N","Recommended":false,"Default":"2","Name":"version"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["text","json","html","xml"],"Default":"text","Name":"format"}],"Synopsis":"Save a Template, or Overwrite an Existing One","returnFormats":[{"accept":"text/plain","Name":"text"},{"accept":"application/json","Name":"json"},{"accept":"text/html","Name":"html"},{"accept":"application/xml","Name":"xml"}]}],"name":"Template Upload","URI":"/service/template/upload"},{"identifier":"ws-template-results","methods":[{"DescriptionFormat":"markdown","Description":"Templates are predefined parameterised queries which may be run by supplying values and\noperators for the available editable constraints. The editable constraints vary from\ntemplate to template, so knowledge of these (obtainable by calls to `/templates`)\nis required to use this service correctly.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","ALSO":"POST","URI":"/template/results","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Type":"Integer","Description":"The index of the first result to return.","Required":"N","Recommended":false,"Default":"0","Name":"start"},{"Type":"Integer","Description":"The maximum size of the result set.","Required":"N","Recommended":false,"Default":"10","Name":"size"},{"Type":"enumerated","Description":"Include column headers. Use friendly for human readable paths. (Only for flat-file formats)","Required":"N","Recommended":false,"EnumeratedList":["none","path","friendly"],"Default":"none","Name":"columnheaders"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["tab","csv","count","json","jsonobjects","jsoncount","xml","html"],"Default":"tab","Name":"format"}],"Synopsis":"Get the results from running a template with a given set of parameters","returnFormats":[{"accept":"application/tsv","Name":"tab"},{"accept":"application/csv","Name":"csv"},{"accept":"text/count","Name":"count"},{"key":"results","accept":"application/json","Name":"json"},{"key":"results","accept":"application/json;type=objects","Name":"jsonobjects"},{"key":"count","accept":"application/json;type=count","Name":"jsoncount"},{"accept":"application/xml","Name":"xml"},{"accept":"text/html","Name":"html"}]},{"DescriptionFormat":"markdown","Description":"Templates are predefined parameterised queries which may be run by supplying values and\noperators for the available editable constraints. The editable constraints vary from\ntemplate to template, so knowledge of these (obtainable by calls to `/templates`)\nis required to use this service correctly.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"POST","RequiresAuthentication":"false","ALSO":"POST","URI":"/template/results","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Type":"Integer","Description":"The index of the first result to return.","Required":"N","Recommended":false,"Default":"0","Name":"start"},{"Type":"Integer","Description":"The maximum size of the result set.","Required":"N","Recommended":false,"Default":"10","Name":"size"},{"Type":"enumerated","Description":"Include column headers. Use friendly for human readable paths. (Only for flat-file formats)","Required":"N","Recommended":false,"EnumeratedList":["none","path","friendly"],"Default":"none","Name":"columnheaders"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["tab","csv","count","json","jsonobjects","jsoncount","xml","html"],"Default":"tab","Name":"format"}],"Synopsis":"Get the results from running a template with a given set of parameters","returnFormats":[{"accept":"application/tsv","Name":"tab"},{"accept":"application/csv","Name":"csv"},{"accept":"text/count","Name":"count"},{"key":"results","accept":"application/json","Name":"json"},{"key":"results","accept":"application/json;type=objects","Name":"jsonobjects"},{"key":"count","accept":"application/json;type=count","Name":"jsoncount"},{"accept":"application/xml","Name":"xml"},{"accept":"text/html","Name":"html"}]}],"name":"Template Results","URI":"/service/template/results"},{"identifier":"ws-template-to-list","methods":[{"DescriptionFormat":"markdown","Description":"This service allows the user to create a list from the result set of running a template\nwith a given set of parameters. The parameters for running the template are the same as when\nrequesting results (see documentation for `template-results`), and in addition to these\nparameters the user needs to supply a name and optional description for the list to be created.\n\nTo define which part of the template results to use, the user must supply a path parameter which\nindicates a valid column from the output to be used.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"POST","URI":"/template/tolist","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Options":"/templates|templates.$name.select","Type":"String","Description":"The path to use to compose the results. This should be one of the selected view paths.","Required":"Y","Recommended":false,"Default":"{}","Name":"path"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Type":"String","Description":"The name for the new list. There must be no existing list of this name","Required":"Y","Recommended":false,"Name":"listName"},{"Type":"String","Description":"A description to attach to the new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Create a List from the Output of a Template","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"DescriptionFormat":"markdown","Description":"This service allows the user to create a list from the result set of running a template\nwith a given set of parameters. The parameters for running the template are the same as when\nrequesting results (see documentation for `template-results`), and in addition to these\nparameters the user needs to supply a name and optional description for the list to be created.\n\nTo define which part of the template results to use, the user must supply a path parameter which\nindicates a valid column from the output to be used.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"POST","URI":"/template/tolist","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Options":"/templates|templates.$name.select","Type":"String","Description":"The path to use to compose the results. This should be one of the selected view paths.","Required":"Y","Recommended":false,"Default":"{}","Name":"path"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Type":"String","Description":"The name for the new list. There must be no existing list of this name","Required":"Y","Recommended":false,"Name":"listName"},{"Type":"String","Description":"A description to attach to the new list","Required":"N","Recommended":false,"Name":"description"},{"Type":"String[]","Description":"A set of tags to use to categorise the new list","Required":"N","Recommended":false,"Name":"tags"},{"Type":"boolean","Description":"Whether or not to replace any existing list of this name","Required":"N","Recommended":false,"Default":"false","Name":"replaceExisting"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Create a List from the Output of a Template","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Template to list","URI":"/service/template/tolist"},{"identifier":"ws-template-append","minVersion":4,"methods":[{"DescriptionFormat":"markdown","Description":"This service allows the user to add items to a list from the result set of running a template\nwith a given set of parameters. The parameters for running the template are the same as when\nrequesting results, and in addition to these parameters the user needs to supply the name\nof a list to append the results to.\n\nTo define which part of the template results to use, the user must supply a path parameter which\nindicates a valid column from the output to be used.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","ALSO":"GET","URI":"/template/append/tolist","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Options":"/templates|templates.$name.select","Type":"String","Description":"The path to use to compose the results. This should be one of the selected view paths.","Required":"Y","Recommended":false,"Default":"{}","Name":"path"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Options":"/lists|lists{authorized}","Type":"String","Description":"The name of the list to add items to.","Required":"Y","Recommended":false,"Default":"{name}","Name":"listName"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Add items to a list from a set of results from running a template","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]},{"DescriptionFormat":"markdown","Description":"This service allows the user to add items to a list from the result set of running a template\nwith a given set of parameters. The parameters for running the template are the same as when\nrequesting results, and in addition to these parameters the user needs to supply the name\nof a list to append the results to.\n\nTo define which part of the template results to use, the user must supply a path parameter which\nindicates a valid column from the output to be used.\n\nUsers should provide parameters of the form `constraint{N}`, `op{N}`, `value{N}`\nand `extra{N}` for each editable contraint, where `N` represents a number to group\nthe values. The value of the `constraint{N}` parameter serves to identify\nthe constraint, and may not be changed. Values for `op{N}` and `value{N}` must be\ngiven, and may be anything the user requires.\n\nTo run a template, for example which has the following editable constraints:\n```\n\n\n```\n\nThen the user should supply the following parameters to run it with the above values:\n\n| Parameter | Value |\n|---------------------|------------------|\n| constraint1 | Gene.symbol |\n| op1 | eq |\n| value1 | eve |\n| constraint2 | Gene.length |\n| op2 | gt |\n| value2 | 1000 |\n\nThe value of the number used to identify each constraint is ignored - it must however be\nconsistent for each parameter. One set of template constraint parameters is required\nfor each editable constraint on the query. These are not required for optional constraints.\n ","HTTPMethod":"GET","RequiresAuthentication":"true","ALSO":"GET","URI":"/template/append/tolist","parameters":[{"Options":"/templates|templates","Type":"String","Description":"The name of the template to run","Required":"Y","Recommended":false,"Default":"{name}","Name":"name"},{"Options":"/templates|templates.$name.select","Type":"String","Description":"The path to use to compose the results. This should be one of the selected view paths.","Required":"Y","Recommended":false,"Default":"{}","Name":"path"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint paths","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{path}","Name":"constraint{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint operators","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{op}","Name":"op{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint values","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{value}","Name":"value{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply constraint codes. Codes are only required if two constraints have the same path.","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{code}","Name":"code{N}"},{"Type":"String[]","Description":"One of a variable set of parameters used to supply extra constraint values (used by LOOKUP constraints)","Required":"N","Recommended":false,"Repeat":"/templates|templates.$name.where{editable}","Default":"{extraValue}","Name":"extra{N}"},{"Options":"/lists|lists{authorized}","Type":"String","Description":"The name of the list to add items to.","Required":"Y","Recommended":false,"Default":"{name}","Name":"listName"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["json","text"],"Default":"json","Name":"format"}],"Synopsis":"Add items to a list from a set of results from running a template","returnFormats":[{"accept":"application/json","Name":"json"},{"accept":"text/plain","Name":"text"}]}],"name":"Append to List from Template Results","URI":"/service/template/append/tolist"},{"identifier":"ws-template","methods":[{"DescriptionFormat":"markdown","Description":"Get a listing of the templates configured in an InterMine instance.\nEach template contains a description of its properties, defining the\nparameters that must be provided to run it, as well as a definition of the\noutput format for its results.\n\nIf the request is authenticated to a user, then the templates that that has access\nto will also be returned.\n ","HTTPMethod":"GET","RequiresAuthentication":"false","URI":"/templates","parameters":[{"Type":"boolean","Description":"Whether or not to include invalid templates. Invalid templates cannot be run.","Required":"N","Recommended":false,"Default":"false","Name":"includeBroken"},{"Type":"enumerated","Description":"Output format","Required":"N","EnumeratedList":["xml","json"],"Default":"xml","Name":"format"}],"Synopsis":"Get the list of available templates.","returnFormats":[{"Name":"xml"},{"key":"templates","Name":"json"}]},{"Description":"Upload a set of templates to the current user profile.\n ","HTTPMethod":"POST","RequiresAuthentication":"true","bodyDescription":"The templates to upload. If using body content.","body":[{"contentType":"application/xml","example":"