ZINC15:Syntax: Difference between revisions
Jump to navigation
Jump to search
(asdf) |
(asdf) |
||
| Line 1: | Line 1: | ||
ZINC 15 uses a uniform set of rules to interpret the URL. This format describes both the web pages and the API, and can be summarized as follows: | |||
'''http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints] | '''http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints]''' | ||
where items in [ square brackets ] are optional, and: | |||
{{TOCright}} | {{TOCright}} | ||
* '''host''' = zinc15.docking.org. during beta it is something else. ask us. | * '''host''' = zinc15.docking.org. during beta it is something else. ask us. | ||
* '''resource''' is one of the 15 [[ZINC15:Resources]]. By far the most common are substances, catalogs and genes. | * '''resource''' is one of the 15 [[ZINC15:Resources]]. By far the most common are substances, catalogs and genes. | ||
| Line 15: | Line 13: | ||
* [[ZINC15:Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]] | * [[ZINC15:Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]] | ||
We illustrate the use of the website and the API with [[ZINC15:examples]]. | |||
Back to [[ZINC15]] | |||
[[Category:API]] | [[Category:API]] | ||
[[Category:ZINC]] | [[Category:ZINC]] | ||
Revision as of 22:29, 4 March 2015
ZINC 15 uses a uniform set of rules to interpret the URL. This format describes both the web pages and the API, and can be summarized as follows:
http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints]
where items in [ square brackets ] are optional, and:
- host = zinc15.docking.org. during beta it is something else. ask us.
- resource is one of the 15 ZINC15:Resources. By far the most common are substances, catalogs and genes.
- format is one of the 12 ZINC15:Formats. If omitted, a web page is requested.
- properties is one or more of the ZINC15:properties. Not all properties make sense in all resource contexts. ZINC15:Examples are provided. There are sensible defaults for each resource, so the property specification may be omitted.
- variant is optionally one or more of the supported ZINC15:Variants.
- ZINC15:Page Controls are optional, and are used to qualify how a search is to be performed and formatted for the page.
- ZINC15:Constraints are optional, and may be qualified with ZINC15:Query operators
We illustrate the use of the website and the API with ZINC15:examples.
Back to ZINC15