Retrieve Genomics Specimen Identifiers for Clinical Specimen Identifiers
get
/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/genomicspecimens
This endpoint supports the retrieval of Patient/Subject Genomic Specimen Row IDs List for multiple Clinical Specimens Row IDs, if Clinical Specimen is valid and has corresponding omics data.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
apiContext: string
Pattern:
subjectapi|patientapi
Patient/Subject API context
Query Parameters
-
id: array
Collection Format:
multi
Minimum Number of Items:1
Maximum Number of Items:2147483647
Patient/Subject Clinical Specimen Row IDs List -
limit(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
offset(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollectionGenomicSpecimen
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : GenomicSpecimen
Type:
Show Source
object
-
genomicFileMetadata(optional):
object LinkedReference
-
genomicSpecimenMetadata(optional):
object LinkedReference
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
patient(optional):
object LinkedReference
-
resourceType(optional):
string
-
specimenNumber(optional):
string
Specimen identifier in linked Specimen Datasource Database
-
specimenVendorNumber(optional):
string
Vendor Identifier in linked Specimen Datasource Database
-
subject(optional):
object LinkedReference
Nested Schema : Identifier
Type:
object
Identifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
400 Response
Invalid parameters supplied
404 Response
Genomic specimen or genomic specimen metadata not found
Examples
The following example submits a GET request.
API URL ??? Patient Context
http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType": "GenomicSpecimen", "items": [ { "identifier": { "system": "ODB", "value": "71" }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/genomicspecimens/97" } }, { "identifier": { "system": "ODB", "value": "63" }, "patient": { "reference": "/ohfapi/cg/v3.3/patientapi/genomicspecimens/96" } } ], "count": 2, "hasMore": false, "links": [ { "rel": "self", "href": "http://loalhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0" } ] }
API URL ??? Subject Context
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType": "GenomicSpecimen", "items": [ { "identifier": { "system": "ODB", "value": "63" }, "subject": { "reference": "/ohfapi/cg/v3.3/subjectapi/genomicspecimens/96" } }, { "identifier": { "system": "ODB", "value": "71" }, "subject": { "reference": "/ohfapi/cg/v3.3/subjectapi/genomicspecimens/97" } } ], "count": 2, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/genomicspecimens?id=96&id=97&limit=20&offset=0" } ] }