Get a NEON sample
neon_get_sampleTrace a sample's custody chain: get identifiers, custody events, parents, and children. Look up by tag, UUID, barcode, or archive GUID, and expand to relatives by degree.
Instructions
A physical sample's custody chain (NEON API token required): identifiers, events with their field values, parents and children; degree=N adds relatives N steps away. Identify it by tag (+class), UUID, barcode or archive GUID; an ambiguous tag asks which class (MRTR) or lists candidates. Next: follow parent or child identifiers with another neon_get_sample call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| degree | No | Also return relatives up to this many degrees away. | |
| fields | No | Keep only these smsKey fields in events. | |
| offset | No | ||
| barcode | No | Sample barcode. | |
| sample_tag | No | Sample tag (use with sample_class when it is ambiguous). | |
| sample_uuid | No | Sample UUID. | |
| archive_guid | No | Biorepository archive GUID. | |
| events_limit | No | ||
| sample_class | No | Sample class of the tag, e.g. bet_IDandpinning_in.individualID. | |
| include_events | No | Include custody events (field entries folded into objects). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| items | Yes | ||
| notes | No | ||
| degree | No | ||
| source | No | ||
| resolved | No | ||
| nextSteps | No | ||
| identifier | Yes |