ZINC15:Syntax

From DISI
Revision as of 22:23, 4 March 2015 by Frodo (talk | contribs) (asdf)
Jump to navigation Jump to search

The general form of a ZINC 15 api request is

http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints]

Where items in [ square brackets ] are optional.

  • 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

The use of the Webapi is illustrated with numerous ZINC15:examples.