HUhubmapconsortium

Get the siblings list for an Entity. The siblings have the same direct ancestor. This list does not include all nodes whom have common ancestors, only the direct ancestor.

Changed on
get/entities/{id}/siblings

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

include-old-revisions'true' | 'false'

A case insensitive string. Any value besides true will have no effect. If the string is 'true', datasets that are have newer revisions will be included, otherwise by default they are not included.

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 sibling entities is returned

object[] required

Changes

  • 2fcb1e3c58aeRevision 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

  • 79987e9684bbRevision changes
    • breaking

      removed the enum value New from the query request parameter status

    • breaking

      removed the enum value Qa from the query request parameter status

    • breaking

      removed the enum value p=Published 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