# Genomics API . referencesets

## Instance Methods

Gets a reference set. Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

Searches for reference sets which match the given criteria. Implements [GlobalAllianceApi.searchReferenceSets](http://ga4gh.org/documentation/api/v0.5.1/ga4gh_api.html#/schema/org.ga4gh.searchReferenceSets).

### Method Details

`get(referenceSetId, x__xgafv=None)`

    Gets a reference set. Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

    Args:
      referenceSetId: string, The ID of the reference set. (required)
      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
        "description": "A String", # Free text description of this reference set.
        "sourceUri": "A String", # The URI from which the references were obtained.
        "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set.
          "A String",
        ],
        "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `NC_000001.11`.
          "A String",
        ],
        "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
        "id": "A String", # The server-generated reference set ID, unique across all reference sets.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome.
      }

`search(body, x__xgafv=None)`

    Searches for reference sets which match the given criteria. Implements [GlobalAllianceApi.searchReferenceSets](http://ga4gh.org/documentation/api/v0.5.1/ga4gh_api.html#/schema/org.ga4gh.searchReferenceSets).

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    {
        "md5checksums": [ # If present, return references for which the `md5checksum` matches. See `ReferenceSet.md5checksum` for details.
          "A String",
        ],
        "assemblyId": "A String", # If present, return reference sets for which a substring of their `assemblyId` matches this string (case insensitive).
        "accessions": [ # If present, return references for which the accession matches any of these strings. Best to give a version number, for example `GCF_000001405.26`. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
          "A String",
        ],
        "pageSize": 42, # Specifies the maximum number of results to return in a single page.
        "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
      }

      x__xgafv: string, V1 error format.

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
        "referenceSets": [ # The matching references sets.
          { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references.
            "description": "A String", # Free text description of this reference set.
            "sourceUri": "A String", # The URI from which the references were obtained.
            "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set.
              "A String",
            ],
            "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
            "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `NC_000001.11`.
              "A String",
            ],
            "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format.
            "id": "A String", # The server-generated reference set ID, unique across all reference sets.
            "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome.
          },
        ],
      }