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

v1.0

get

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

Returns data element history records filtered by date range using cursor pagination.

Supported filter points:

  • Study-level retrieval: omit both siteId and subjectIds.
  • Site-level retrieval: supply siteId.
  • Subject-level retrieval: supply subjectIds as a comma-separated list of up to 50 subject identifiers.

siteId and subjectIds must not both be supplied. 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.

Subject-list request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/dataelements/all/dateRange?subjectIds=10F75668189F422F9A461A315D211111,20F75668189F422F9A461A315D222222&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&limit=25

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
  • Required. 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
  • Optional opaque cursor token. Do not provide pageToken on the first request. When hasMore is true, pass the previous response nextPageToken as pageToken in the next request exactly as received. Consumers must not modify nextPageToken.
    Example:
    MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    ABCDEF1234567890ABCDEF1234567890
  • Required. 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
  • Optional comma-separated list of subject identifiers. Accepted only when siteId is omitted. Maximum 50 values. Example: subjectIds=10F75668189F422F9A461A315D211111,20F75668189F422F9A461A315D222222.
    Example:
    10F75668189F422F9A461A315D211111,20F75668189F422F9A461A315D222222

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful response with cursor metadata and data element history records. The result object contains hasMore, limit, nextPageToken, and resultData.
Body ()
Root Schema : DataElementDateRangeResponse
Type: object
Response body containing data element date-range results.
Show Source
Nested Schema : errorData
Type: object
Example:
oracle.doceng.json.BetterJsonNull@5bfda09a
Nested Schema : DataElementDateRangeCursor
Type: object
Cursor metadata and data element records.
Show Source
Nested Schema : resultData
Type: array
Show Source
Nested Schema : DataElementsDateRangeDtoV1
Type: object
Data element details including form status information for the associated form.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for the data element change
    Example: Captured by device
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Date-time value in UTC
    Example: 2025-10-16T14:30:31.892Z
  • Day part of date
    Example: 16
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ADF5A7800A954FA5B831E7B6B9CA39A9
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.
    Example: 1
  • Numeric decimal value
    Example: 12.34
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
  • Status of the form. Status can be NEW, OPTIONAL, COMPLETED, COMPLETED_WITH_ERROR, IN_PROGRESS, IN_PROGRESS_WITH_ERROR, INCOMPLETE, INCOMPLETE_WITH_ERROR or DELETED.
    Example: COMPLETED
  • Freeze status of the data element,can have Values NOT_APPLICABLE, FROZEN
    Example: FROZEN
  • Hour part of time
    Example: 14
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.
    Example: DETAIL
  • The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.
    Example: FLAG
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.
    Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
  • The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.
    Example: REASON
  • Type of item represented by this data element
    Example: TEXT
  • Minimum Length: 0
    Maximum Length: 64
    Measurement unit
    Example: mg/dL
  • Minute part of time
    Example: 30
  • Month part of date
    Example: 10
  • Identifier of normalized unit
    Example: A78AD8C31CD843CD8B847C06C0420FF5
  • Minimum Length: 0
    Maximum Length: 100
    Normalized value if applicable
    Example: 120
  • Numeric integer value
    Example: 120
  • Audit trail field that represents the version number of the data.
    Example: 14
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: FEDCBA9876543210FEDCBA9876543210
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the data element change
    Example: Initial entry
  • Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.
    Example: 2
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
  • Identifier of root data element in UUID, 32-character uppercase hexadecimal string.
    Example: 1234567890ABCDEF1234567890ABCDEF
  • Second part of time
    Example: 31
  • Signature status of the data element, can have Values NOT_APPLICABLE, SIGNED
    Example: SIGNED
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Software version number
    Example: 14
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Study name
    Example: STUDY-ABC
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: 10F75668189F422F9A461A315D211111
  • The date and time at which the transaction processing completed.
    Example: 2025-10-16T14:30:31.892Z
  • The date and time at which the transaction processing began.
    Example: 2025-10-16T14:30:31.892Z
  • Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.
  • Minimum Length: 0
    Maximum Length: 32767
    Validation failure details if any
    Example: Incorrect values not allowed
  • Minimum Length: 0
    Maximum Length: 25
    Validation status of the data element. The validation status can be null or SUCCESS.
    Example: SUCCESS
  • Minimum Length: 0
    Maximum Length: 4000
    Raw value captured for the item
    Example: 120
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: 0123456789ABCDEF0123456789ABCDEF
  • Minimum Length: 0
    Maximum Length: 100
    Vendor code if provided
    Example: VENDOR1
  • Verification status of the data element can have Values NOT_APPLICABLE, VERIFIED
    Example: VERIFIED
  • End timestamp of the data element version
    Example: 2025-10-16T14:30:31.892Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Year part of date
    Example: 2025
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 or subjectIds, both siteId and subjectIds supplied, 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