ZINC15:Syntax: Difference between revisions

From DISI
Jump to navigation Jump to search
(asdf)
(asd)
Line 3: Line 3:
{{TOCright}}
{{TOCright}}


= Overall URL Syntax =
= Overall Syntax =
The general form of the ZINC15 URL is:
The general form of the ZINC15 URL is:
'''http[s]://host/resource[.format[:properties][/variant][?page-view-controls | resource-constraints]'''
 
where items in [ square brackets ] are optional, and:
'''http[s]://zinc15.docking.org/<RESOURCE>(.<FORMAT>[:<FIELDS>]|/<VIEW_TEMPLATE>.html)?<PREDICATE_LIST>[&<PAGE_OPTIONS>]
* '''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.
The items in [ square brackets ] are optional. The items in < angled braces > are each described below.  
* '''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.
* <RESOURCE> is an object type, such as molecules, catalogs or genes, and are fully described here: [[ZINC15:Resources]]
* '''variant''' is optionally one or more of the supported [[ZINC15:Variants]].
 
* <FORMAT> is one of the supported formats, such as smi, sdf, csv, fully described here:  [[ZINC15:Formats]]. If a format is omitted, a webpage is implicitly requested.
 
* <FIELDS> are individual properties, including calculated ones, and are described together with the [[ZINC15:Resources]] to which they belong.
[[ZINC15:properties]] Not all properties make sense in all resource contexts.  [[ZINC15:examples]] are provided. Each resource has default fields, if none are specified.  
 
* <VIEW_TEMPLATE> is one of (tile, table, detail, etc.) (only available if the underlying template exists); where items in [ square brackets ] are optional, and:
 
[[ZINC15:Variants]].
 
* <PREDICATE_LIST> is a query string, one or more of <PREDICATE> delimited by &<PREDICATE> is <ATTRIBUTE>[:<OPERATOR>[;<OPERATOR_ARGS>]]=<THRESHOLD>
 
* [[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:Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]]
* [[ZINC15:Constraints]] are optional, and may be qualified with [[ZINC15:Query operators]]


= Resources =
Resources are things, like molecules, catalogs or genes that you can search, display and download.  The resources available in ZINC15 are described in the [[ZINC15:Resources]] pages.


= Reserved words =  
= Reserved words =  
Line 23: Line 33:
= Examples =
= Examples =
We illustrate the use of the website and the API with [[ZINC15:examples]].  
We illustrate the use of the website and the API with [[ZINC15:examples]].  
The new interface is described in a set of web accessible tools that exemplify its use:
= YouTube videos =
= Python scripts =
=  iPython Notebooks =
*  as well as numerous examples in the Results, available online at [[ZINC15:examples]].


Back to [[ZINC15]]
Back to [[ZINC15]]
[[Category:API]]
[[Category:API]]
[[Category:ZINC]]
[[Category:ZINC]]

Revision as of 21:26, 25 March 2015

ZINC 15 uses a uniform set of rules to interpret the URL allowing both web pages and a machine-readable application programming interface (API). This page describes both.

Overall Syntax

The general form of the ZINC15 URL is:

http[s]://zinc15.docking.org/<RESOURCE>(.<FORMAT>[:<FIELDS>]|/<VIEW_TEMPLATE>.html)?<PREDICATE_LIST>[&<PAGE_OPTIONS>]

The items in [ square brackets ] are optional. The items in < angled braces > are each described below.

  • <RESOURCE> is an object type, such as molecules, catalogs or genes, and are fully described here: ZINC15:Resources
  • <FORMAT> is one of the supported formats, such as smi, sdf, csv, fully described here: ZINC15:Formats. If a format is omitted, a webpage is implicitly requested.
  • <FIELDS> are individual properties, including calculated ones, and are described together with the ZINC15:Resources to which they belong.

ZINC15:properties Not all properties make sense in all resource contexts. ZINC15:examples are provided. Each resource has default fields, if none are specified.

  • <VIEW_TEMPLATE> is one of (tile, table, detail, etc.) (only available if the underlying template exists); where items in [ square brackets ] are optional, and:
ZINC15:Variants.
  • <PREDICATE_LIST> is a query string, one or more of <PREDICATE> delimited by &<PREDICATE> is <ATTRIBUTE>[:<OPERATOR>[;<OPERATOR_ARGS>]]=<THRESHOLD>
  • ZINC15:Page Controls are optional, and are used to qualify how a search is to be performed and formatted for the page.


Reserved words

  • list, tile, subsets, help, overview - these have special meaning in the URL, and can never be the names of resources or their columns.

Examples

We illustrate the use of the website and the API with ZINC15:examples.

Back to ZINC15

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