Get the tuplets list for an Entity. The tuplets have the same parent activity node.

Changed on
get/entities/{id}/tuplets

Request

  • Base URL
    https://entity.api.hubmapconsortium.org
  • Auth
    • API key in header Authorization
    • or none

Path parameters

idstring required

The unique identifier of entity. This identifier can be either an HuBMAP ID (e.g. HBM123.ABCD.456) or UUID

Query parameters

status'New' | 'QA' | 'Published'

A case insensitive string. Any value besides 'New', 'Qa', and 'Published' will raise an error. If a valid status is provided, only results matching that status (if they are datasets) will be returned

property_key'uuid'

A case insensitive string. Any value besides 'uuid' will raise an error. If property_key=uuid is provided, rather than entire dictionary representations of each node, only the list of matching uuid's will be returned

Response

An array of tuplet entities is returned

object[] required

Changes

    • breaking

      removed the enum value new from the query request parameter status

    • breaking

      removed the enum value published from the query request parameter status

    • breaking

      removed the enum value qa from the query request parameter status

    • info

      added the new enum value New to the query request parameter status

    • info

      added the new enum value Published to the query request parameter status

    • info

      added the new enum value QA to the query request parameter status

    • breaking

      removed the enum value New from the query request parameter status

    • breaking

      removed the enum value Published from the query request parameter status

    • breaking

      removed the enum value Qa from the query request parameter status

    • info

      added the new enum value new to the query request parameter status

    • info

      added the new enum value published to the query request parameter status

    • info

      added the new enum value qa to the query request parameter status