Retrieve Study Specimens for a Study Identifier
get
/ohfapi/cg/v3.3/studies/{id}/specimens
This endpoint supports the retrieval of Study Specimens for a Study Row ID passed.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Study Row ID
Query Parameters
-
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 : PageableCollection
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 : Serializable
Type:
object
400 Response
Invalid parameters supplied
404 Response
Specimens were not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/studies/2/specimens?limit=10&offset=0
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "StudySpecimen", "items": [ { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/61" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/62" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/63" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/64" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/65" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/66" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/67" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/68" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/69" }, { "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/70" } ], "count": 10, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/studies/2/specimens?limit=10&offset=0" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/studies/2/specimens?offset=10&limit=10" } ] }