8edff70d53e7dfe812ccb5c95a452fb2f4831716 hiram Fri Apr 19 10:22:32 2019 -0700 adding the jsonOutputArrays option refs #18869 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 2efd0ef..239d3f1 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -82,54 +82,55 @@

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
 

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
/getData/track((hubUrl and genome) or db) 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.

Using the chrom=<name> parameter will limit the request to the single specified chromosome. To limit the request to a specific