ZINC15:help

From DISI
Revision as of 06:42, 10 October 2015 by Frodo (talk | contribs) (→‎Header: asdf)
Jump to navigation Jump to search

Each resource in ZINC15 has an associated help page. Thus for substances, the page is /substances/help.

Each /<resource>/help page is divided into six sections, which we take up in turn below. Please look elsewhere for the ZINC15:Syntax or ZINC15 query URLs.

Header

  • Identifying attribute: this is how items of this resource are called in the URL. Thus for instance, substances have their zinc_id as an identifying attribute, and correspondingly the URL for say ZINC molecule 7 would be /substances/7 or /substances/ZINC7.
  • Resource name: This is the plural form of the resource, and is used as the first item in the URL.
  • Endpoint root: This seems to always just be the resource name surrounded by forward slash (/). Teague: is there a subtlety here I've missed?
  • Endpoint home: The /home/ endpoint is the default destination from the menu. The home resource typically allows access to help, examples, browsing, subsets and free text search of that resource. The page may also contain other features. The Tranche Browser is an important exception to this rule.
  • Subsets: N. The number of subsets. Links to the URL /<resource name>/subsets/

Attributes

The columns are:

  • Name: this is the name used in the URL
  • Type: this is the data type. In general, we perform type conversions automatically, but type does limit the kinds of queries that may be asked.
  • Description
  • Searchable

Columns

Hybrids (computed in database)

Aliases to related resource attributes

Computed properties

Related resources