438e3f1d32b858255405c7bb3fccb7190d06fca1 hiram Sun Apr 28 13:12:25 2019 -0700 eliminating the db= argument everywhere, only need genome= refs #18869 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 413bf32..b52332a 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -75,75 +75,71 @@
  • /list/ucscGenomes - list UCSC database genomes
  • /list/hubGenomes - list genomes from specified hub
  • /list/tracks - list data tracks available in specified hub or database genome (see also: track definition help)
  • /list/chromosomes - list chromosomes from a data track in specified hub or database genome
  • /getData/sequence - return sequence from specified hub or database genome
  • /getData/track - return data from specified track in hub or database genome
  • Parameters to endpoint functions

    The parameters are added to the endpoint URL beginning with a question mark ?, and multiple parameters are separated with the semi-colon ;. For example:

    -https://api-test.gi.ucsc.edu/getData/sequence?db=ce11;chrom=chrM
    +https://api-test.gi.ucsc.edu/getData/sequence?genome=ce11;chrom=chrM
     

    Required and optional parameters

    - - - - + + + +
    Endpoint functionRequiredOptional
    /list/publicHubs(none)(none)
    /list/ucscGenomes(none)(none)
    /list/hubGenomeshubUrl(none)
    /list/tracks(hubUrl and genome) or dbtrackLeavesOnly=1
    /list/chromosomes((hubUrl and genome) or db) and track(none)
    /getData/sequence((hubUrl and genome) or db) and chromstart and end
    /getData/track((hubUrl and genome) or db) and trackchrom, (start and end), maxItemsOutput, jsonOutputArrays
    /list/tracksgenome or (hubUrl and genome)trackLeavesOnly=1
    /list/chromosomesgenome or (hubUrl and genome)track
    /getData/sequence(genome or (hubUrl and genome)) and chromstart and end
    /getData/track(genome or (hubUrl and genome)) and trackchrom, (start and end), maxItemsOutput, jsonOutputArrays

    The hubUrl and genome parameters are required together to specify a unique genome in an assembly or track hub. The genome for a track hub will usually be a UCSC database genome. Assembly hubs will -have their own unique genome sequences. -

    -

    -When not an assembly or track hub, to access UCSC database assemblies, -the parameter db=<name> is required. +have their own unique genome sequences. Specify genome without +a hubUrl to refer to a UCSC genome browser assembly.

    Using the chrom=<name> parameter will limit the request to the single specified chromosome. To limit the request to a specific position, both start=4321 and end=5678 must be given together.

    Supported track types, at this time (April 2019), for getData functions