REST API for Oracle Healthcare Translational Research

Retrieve Study Specimens for a Study Identifier

get

/HSDataService-web/api/3.2.0/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: Type: integer (int64)

Required: true

Study Row ID

Query Parameters

limit: Type: integer (int32)

Pagination query params: ?limit=2&offset=0
offset: Type: integer (int32)

Pagination query params: ?limit=2&offset=0

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionLinkedReference

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object LinkedReference

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

400 Response

Invalid parameters supplied

404 Response

Specimens were not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/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": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/61"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/62"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/63"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/64"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/65"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/66"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/67"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/68"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/69"
    },
    {
      "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/70"
    }
  ],
  "count": 10,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/studies/2/specimens?limit=10&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/studies/2/specimens?offset=10&limit=10"
    }
  ]
}