1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Data Integration
  4. Subjects
  5. Get subject history by date range

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/all/dateRange

Returns subject history records filtered by site and date range using cursor pagination.

Supported filter points:

  • Site-level retrieval: supply siteId. This API is site-scoped.
  • Date-range retrieval: supply startDate and endDate.
  • Replacement-randomization records follow the caller's subject history permissions.

The inclusive date range is applied to versionStart; records are eligible when versionStart >= startDate and versionStart <= endDate. The response is ordered by versionStart in ascending order.

Cursor pagination: omit pageToken on the first request. Invoke the next-page request only when hasMore is true. To retrieve the complete data set, pass the previous response nextPageToken as the next request pageToken exactly as received. Consumers must not modify nextPageToken. In the corner case where the response contains records equal to the requested limit, hasMore may still be true and nextPageToken may be returned even when no additional records are available.

First request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/subjects/history/all/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&limit=25

Next-page request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/subjects/history/all/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&pageToken=MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ&limit=25

Note: Code break fields are not exposed in this response because the inherited codeBreak property is hidden in the shared subject DTO.

Request

Path Parameters
  • Indicates the operational mode of the study. Accepted values: active, test, or training.
    Example:
    active
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    ABCDEF1234567890ABCDEF1234567890
Query Parameters
  • Inclusive date-range end in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or before this value are eligible. The end date must be later than the start date.
    Example:
    01-Jun-2026 10:15:30.456
  • Minimum Value: 1
    Maximum Value: 10000
    Required. Maximum number of records to return. Accepted values are positive integers from 1 through 10000; negative values are not accepted. The value is an upper bound; fewer records may be returned when no additional matching records exist.
    Example:
    25
  • Opaque cursor token returned as nextPageToken from the previous page. Do not parse or modify this value. Omit it on the first request.
    Example:
    MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    ABCDEF1234567890ABCDEF1234567890
  • Inclusive date-range start in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or after this value are eligible.
    Example:
    01-Jun-2026 09:15:30.123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful response with cursor metadata and subject history records. The result object contains hasMore, limit, nextPageToken, and resultData.
Body ()
Root Schema : SubjectHistoryDateRangeResponse
Type: object
Response body containing subject history date-range results.
Show Source
Nested Schema : errorData
Type: object
Example:
oracle.doceng.json.BetterJsonNull@508a49ad
Nested Schema : SubjectHistoryDateRangeCursor
Type: object
Cursor metadata and subject history records.
Show Source
Nested Schema : resultData
Type: array
Show Source
Nested Schema : SubjectRespDto14
Type: object
Subject response details including fields like replacement randomization, unresolved queries etc..
Show Source
Examples

400 Response

Bad request. Returned for validation failures. The response provides a distinct validation message in errorData.details for each failed filter or cursor rule, including invalid date format, missing required parameters, endDate not later than startDate, invalid siteId, unsupported offset parameter, invalid pageToken, or limit outside 1 through 10000.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

401 Response

Unauthorized. Returned when the request does not contain a valid authenticated session or token.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

403 Response

Forbidden. Returned when the authenticated user does not have access to the requested site.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

404 Response

Not found. Returned when the API is not available.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

500 Response

Internal server error. Returned for unexpected service or downstream failures.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

Back to Top