ZINC15:Syntax - Revision history

Khtang at 01:01, 5 January 2019

2019-01-05T01:01:27Z

← Older revision		Revision as of 01:01, 5 January 2019
Line 150:		Line 150:
	Back to [[ZINC15]]		Back to [[ZINC15]]
	[[Category:API]]		[[Category:API]]
	[[Category:~~ZINC~~]]		[[Category:ZINC15]]

Teague Sterling at 18:11, 14 October 2015

2015-10-14T18:11:54Z

← Older revision		Revision as of 18:11, 14 October 2015
Line 7:		Line 7:

	All URLs will be provided relative to [//zinc15.docking.org zinc15.docking.org], thus /substances/ implies [http://zinc15.docking.org/substances/ zinc15.docking.org/substances/].		All URLs will be provided relative to [//zinc15.docking.org zinc15.docking.org], thus /substances/ implies [http://zinc15.docking.org/substances/ zinc15.docking.org/substances/].

			= Syntax =

	The full syntax of a query is defined as:		The full syntax of a query is defined as:
Line 15:		Line 17:
	More Concisely, this can be written as:		More Concisely, this can be written as:
	<pre style="overflow-x: scroll">		<pre style="overflow-x: scroll">
	/<Root>[/<Subsets>][/<Existential>[/<Ext. Subsets>]]<Formatting>?[<Constraints>][<Options>]		/<Root>[/<Subsets>][/<Existential>[/<Ext. Subsets>]]<Formatting>[?[<Constraints>][<Options>]]
	</pre>		</pre>

Line 29:		Line 31:
	\|-		\|-
	\| <RESOURCE>[/<IDENTIFIER>[/<RELATION>]]		\| <RESOURCE>[/<IDENTIFIER>[/<RELATION>]]
	\| ~~Query Root~~ (Root)		\| ('''Root''') <br>Query Root
	\| Defines where the query should be performed: either on the whole resource or only those related to another, single resource.		\| Defines where the query should be performed: either on the whole resource or only those related to another, single resource.
	\| [//zinc15.docking.org/trials/NCT00001251/substances/ /trials/NCT00001251/substances]		\| [//zinc15.docking.org/trials/NCT00001251/substances/ /trials/NCT00001251/substances]
Line 35:		Line 37:
	\|-		\|-
	\| subsets/<SUBSET>[+<SUBSET>...]		\| subsets/<SUBSET>[+<SUBSET>...]
	\| ~~Query Subsets~~ (Subsets)		\| ('''Subsets''') <br>Query Subsets
	\| Applies one or more named, predefined constraints to the query.		\| Applies one or more named, predefined constraints to the query.
	\| [//zinc15.docking.org/substances/subsets/fda+for-sale/ .../subsets/fda+for-sale/]		\| [//zinc15.docking.org/substances/subsets/fda+for-sale/ .../subsets/fda+for-sale/]
Line 41:		Line 43:
	\|-		\|-
	\| having/[no-]<EXT_RELATION>[+[no-]<EXT_RELATION>...]		\| having/[no-]<EXT_RELATION>[+[no-]<EXT_RELATION>...]
	\| ~~Existential Requirements~~ (Existential)		\| ('''Existential''') <br>Existential Requirements
	\| Applies existential (or non-existential with the "no-" prefix) constraints based on on the results of the query		\| Applies existential (or non-existential with the "no-" prefix) constraints based on on the results of the query
	\| [//zinc15.docking.org/genes/having/no-protomers/ .../having/no-protomers/]		\| [//zinc15.docking.org/genes/having/no-protomers/ .../having/no-protomers/]
Line 47:		Line 49:
	\|-		\|-
	\| subsets/[<EXT_RELATION>.]<RELATION_SUBSET>+[[<EXT_RELATION>.]<RELATION_SUBSET>...]		\| subsets/[<EXT_RELATION>.]<RELATION_SUBSET>+[[<EXT_RELATION>.]<RELATION_SUBSET>...]
	\| ~~Existential Relation Subsets~~ (Ext. Subsets)		\| ('''Ext. Subsets''') <br>Existential Relation Subsets
	\| Applies subset requirements to the existential relation requirement (see above) of the query		\| Applies subset requirements to the existential relation requirement (see above) of the query
	\| [//zinc15.docking.org/substances/having/trials/subsets/cancer/ .../subsets/cancer/]		\| [//zinc15.docking.org/substances/having/trials/subsets/cancer/ .../subsets/cancer/]
	\| The relation subsets are completely independent of the query subsets, and valid values depend on the type of the existential resource. When multiple existential relations are specified, the subsets must be prefixed with "<EXT_RELATION>." to identify which they apply to.		\| The relation subsets are completely independent of the query subsets, and valid values depend on the type of the existential resource. When multiple existential relations are specified, the subsets must be prefixed with "<EXT_RELATION>." to identify which they apply to.
	\|-		\|-
	\| (/[<VIEW>.html]\|.<FORMAT>[:<OUTPUT_FIELD>[+<OUTPUT_FIELD>...]])		\| /[<VIEW>.html] OR<br> .<FORMAT>[:<OUTPUT_FIELD>[+<OUTPUT_FIELD>...]]
	\| ~~Formatting Options~~ (Formatting)		\| ('''Formatting''') <br>Formatting Options
	\| Dictates how the result of a query will be returned. If <FORMAT> is specified the result will be sent as a download. If a <VIEW> is specified the result will be rendered as HTML. If neither is provided (just "/") the "Accept" header will be interrogated to determine the requested format, which defaults to HTML.		\| Dictates how the result of a query will be returned. If <FORMAT> is specified the result will be sent as a download. If a <VIEW> is specified the result will be rendered as HTML. If neither is provided (just "/") the "Accept" header will be interrogated to determine the requested format, which defaults to HTML.
	\| [//zinc15.docking.org/majorclasses.json%3Apublic_identifier+name+num_genes+num_substances .json:public_identifier+name +num_genes+num_substances]		\| [//zinc15.docking.org/majorclasses.json%3Apublic_identifier+name+num_genes+num_substances .json:public_identifier+name +num_genes+num_substances]

Teague Sterling at 18:07, 14 October 2015

2015-10-14T18:07:34Z

← Older revision		Revision as of 18:07, 14 October 2015
Line 10:		Line 10:
	The full syntax of a query is defined as:		The full syntax of a query is defined as:
	<pre style="overflow-x: scroll">		<pre style="overflow-x: scroll">
	/<RESOURCE>[/<IDENTIFIER>[/<RELATION>]][/subsets/<SUBSET>[+<SUBSET>...]][/having/[no-]<EXT_RELATION>[+[no-]<EXT_RELATION>...]][/subsets/[<EXT_RELATION>.]<RELATION_SUBSET>+[[<EXT_RELATION>.]<RELATION_SUBSET>...]](/[<VIEW>.html]\|.<FORMAT>[:<~~OUTPUT_FIELDS~~>])[?<~~OUTPUT_OPTION_NAME~~>=<~~OUTPUT_OPTION_VALUE~~>\|<QUERY_FIELD>[-<OPERATOR>[-<OPERATOR_ARG>...]]=<FIELD_CONSTRAINT>[&<~~OUTPUT_OPTION_NAME~~>=<~~OUTPUT_OPTION_VALUE~~>\|<QUERY_FIELD>[-<OPERATOR>[-<OPERATOR_ARG>...]]=<FIELD_CONSTRAINT>...]]		/<RESOURCE>[/<IDENTIFIER>[/<RELATION>]][/subsets/<SUBSET>[+<SUBSET>...]][/having/[no-]<EXT_RELATION>[+[no-]<EXT_RELATION>...]][/subsets/[<EXT_RELATION>.]<RELATION_SUBSET>+[[<EXT_RELATION>.]<RELATION_SUBSET>...]](/[<VIEW>.html]\|.<FORMAT>[:<OUTPUT_FIELD>[+<OUTPUT_FIELD>...]])[?<OPTION_NAME>=<OPTION_VALUE>\|<QUERY_FIELD>[-<OPERATOR>[-<OPERATOR_ARG>...]]=<FIELD_CONSTRAINT>[&<OPTION_NAME>=<OPTION_VALUE>\|<QUERY_FIELD>[-<OPERATOR>[-<OPERATOR_ARG>...]]=<FIELD_CONSTRAINT>...]]
	</pre>		</pre>

	More Concisely, this can be written as:		More Concisely, this can be written as:
	<pre style="overflow-x: scroll">		<pre style="overflow-x: scroll">
	/<Root>[/<Subsets>][/<Existential>[/<Ext. Subsets>]][Formatting]?[Constraints][Options]		/<Root>[/<Subsets>][/<Existential>[/<Ext. Subsets>]]<Formatting>?[<Constraints>][<Options>]
	</pre>		</pre>

Line 52:		Line 52:
	\| The relation subsets are completely independent of the query subsets, and valid values depend on the type of the existential resource. When multiple existential relations are specified, the subsets must be prefixed with "<EXT_RELATION>." to identify which they apply to.		\| The relation subsets are completely independent of the query subsets, and valid values depend on the type of the existential resource. When multiple existential relations are specified, the subsets must be prefixed with "<EXT_RELATION>." to identify which they apply to.
	\|-		\|-
	\| (/[<VIEW>.html]\|.<FORMAT>[:		\| (/[<VIEW>.html]\|.<FORMAT>[:<OUTPUT_FIELD>[+<OUTPUT_FIELD>...]])
			\| Formatting Options (Formatting)
			\| Dictates how the result of a query will be returned. If <FORMAT> is specified the result will be sent as a download. If a <VIEW> is specified the result will be rendered as HTML. If neither is provided (just "/") the "Accept" header will be interrogated to determine the requested format, which defaults to HTML.
			\| [//zinc15.docking.org/majorclasses.json%3Apublic_identifier+name+num_genes+num_substances .json:public_identifier+name +num_genes+num_substances]
			\| Valid views (currently) include table or tile. The default is always tile. Valid [[ZINC15:Formats]] are explained in the wiki. Valid <OUTPUT_FIELD>s depend on the specific resource being requested, and can be found on the resource help pages.
	\|}		\|}

	~~[/subsets/<RELATION_SUBSET>+[<RELATION_SUBSET>...]]~~

Teague Sterling: /* Overall Syntax */

2015-10-14T17:55:05Z

Overall Syntax

@@ Line 3: / Line 3: @@
 {{TOCright}}
-= Overall Syntax =
+= Overview =
-The general forme of the ZINC15 URL is one of the following:
+ZINC15 queries for all resource types can be formulated as HTTP requests using a consistent URL syntax. The syntax is consistent for both interactive (browser-based) and API (script-based) queries. The API downloads are triggered by specifying a download format and, optionally, a list of output fields to include.
 {| class="wikitable"
-|-
+ |-
-! zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>
+ ! Syntax
-|-
+ ! Name
-! zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>
+ ! Explanation
 |}

Frodo: /* Overall Syntax */ asdf

2015-10-13T23:35:26Z

Overall Syntax: asdf

← Older revision		Revision as of 23:35, 13 October 2015
Line 24:		Line 24:

	* <FIELDS> are individual properties, including calculated ones, and are described together with the [[ZINC15:Resources]] to which they belong.		* <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.		[[ZINC15:Properties]] Not all properties make sense in all resource contexts. [[ZINC15:examples]] are provided. Each resource has default fields, if none are specified.

	* <ENDPOINT> is one of (tile, table, detail, etc.) (only available if the underlying template exists); where items in [ square brackets ] are optional, and:		* <ENDPOINT> is one of (tile, table, detail, etc.) (only available if the underlying template exists); where items in [ square brackets ] are optional, and:

Frodo: asdf

2015-10-13T23:34:30Z

asdf

← Older revision		Revision as of 23:34, 13 October 2015
Line 6:		Line 6:
	The general forme of the ZINC15 URL is one of the following:		The general forme of the ZINC15 URL is one of the following:

	<h3>		<B>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 13:		Line 13:
	! zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>		! zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>
	\|}		\|}
	</h3>		</B>

Frodo: /* Overall Syntax */ asdf

2015-10-13T23:33:46Z

Overall Syntax: asdf

← Older revision		Revision as of 23:33, 13 October 2015
Line 6:		Line 6:
	The general forme of the ZINC15 URL is one of the following:		The general forme of the ZINC15 URL is one of the following:

			<h3>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~http://~~zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>		! zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>
	\|-		\|-
	! ~~http://~~zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>		! zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>
	\|}		\|}
			</h3>



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

Frodo: asdf

2015-10-13T23:32:16Z

asdf

← Older revision		Revision as of 23:32, 13 October 2015
Line 4:		Line 4:

	= Overall Syntax =		= Overall Syntax =
	The general ~~form~~ of the ZINC15 URL is:		The general forme of the ZINC15 URL is one of the following:

	{~~{color box~~ \| ~~Yellow~~ \| ~~'''~~http~~[s]~~://zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>~~''' }~~}		{\| class="wikitable"
			\|-
			! http://zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>
			\|-
			! http://zinc15.docking.org/<RESOURCE-PHRASE>/having/<RESOURCE-PHRASE>
			\|}

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

Frodo: /* Overall Syntax */ asdf

2015-10-01T18:12:11Z

Overall Syntax: asdf

← Older revision		Revision as of 18:12, 1 October 2015
Line 26:		Line 26:

	* [[ZINC15:Query operators]]		* [[ZINC15:Query operators]]

			* https is currently not supported, but it will be.

	= Reserved words =		= Reserved words =

Frodo: /* Overall Syntax */ ZXC

2015-10-01T18:07:45Z

Overall Syntax: ZXC

← Older revision		Revision as of 18:07, 1 October 2015
Line 6:		Line 6:
	The general form of the ZINC15 URL is:		The general form of the ZINC15 URL is:

	{{color box \| Yellow \| http[s]://zinc15.docking.org/<RESOURCE>/<ENDPOINT~~> }}~~		{{color box \| Yellow \| '''http[s]://zinc15.docking.org/<RESOURCE>/<ENDPOINT>[.<FORMAT>[:<FIELDS>]][?<PREDICATE_LIST>][&<PAGE_OPTIONS>''' }}

	~~'''http[s]://zinc15.docking.org/<RESOURCE~~>[.<FORMAT>[:<FIELDS>]]/[~~<ENDPOINT>]~~?<PREDICATE_LIST>[&<PAGE_OPTIONS>]

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