Revision as of 21:15, 4 March 2015

The general form of a ZINC 15 api request is

http[s]://host/resource[.format[:columns][/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.
columns is one or more of the ZINC15:Columns. Not all columns make sense in all resource contexts. Examples are provided. There are sensible defaults for each resource, so the column 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:Resource Constraints are optional, and may be qualified with ZINC15:Query operators

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

NP, Drug and BB

quality	values	Notes/Links
NP	0=unknown, 1=biogenic, 2=metabolite, 3=endogenous human metabolite	lala
Drug	0=unknown, 1=annotated catalog, 2=bioactive, 4=bioactive in vitro < 1uM, 5=bioactive in cells <1uM, 6=in man, 8=world drug, 10=fda approved	lala
BB	f=not bb, t=bb	asdf

@@ Line 7: / Line 7: @@
 {{TOCright}}
-* host = zinc15.docking.org
+* '''host''' = zinc15.docking.org. during beta it is something else. ask us.
-* resource is one of the 15 [[ZINC15:Resources]]
+* '''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.
+* '''format''' is one of the 12 [[ZINC15:Formats]].  If omitted, a web page is requested.
-* columns is one or more of the [[ZINC15:Columns]]. Not all columns make sense in all resource contexts.  Examples are provided. There are sensible defaults for each resource, so the column specification may be omitted.
+* '''columns''' is one or more of the [[ZINC15:Columns]]. Not all columns make sense in all resource contexts.  Examples are provided. There are sensible defaults for each resource, so the column specification may be omitted.
-* variant is optionally one or more of the supported [[ZINC15:Variants]].
+* '''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:Resource Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]]