ZINC15:Syntax: Difference between revisions

From DISI
Jump to navigation Jump to search
(asdf)
(asdf)
Line 1: Line 1:
The general form of a ZINC 15 api request is  
The general form of a ZINC 15 api request is  


'''http[s]://host/resource[.format[:columns][/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.
Where items in [ square brackets ] are optional.
Line 10: Line 10:
* '''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.
* '''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.
* '''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]].
* '''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: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]]
* [[ZINC15:Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]]


The use of the Webapi is illustrated with numerous [[ZINC15:examples]].  
The use of the Webapi is illustrated with numerous [[ZINC15:examples]].  
= NP, Drug and BB =
{| class="wikitable"
|-
! 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
|}


[[Category:API]]
[[Category:API]]
[[Category:ZINC]]
[[Category:ZINC]]

Revision as of 22:23, 4 March 2015

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.

Retrieved from "http://wiki.docking.org/index.php?title=ZINC15:Syntax&oldid=8299"