1. REST API for Clinical One Platform
  2. Tasks
  3. Data Integration
  4. Subjects
  5. Get Clinical Data which is part of ODMSubmit

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}

Returns history for the specified subject as multiple subject records for each change that was made, including current details.

Request

Path Parameters
  • Mode of the study, accepts: test, active, or training.
    Example:
    test
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example:
    3F2504E04F8911D39A0C0305E82C3301
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example:
    93CC828113AC439181071CB44D2C6FE5
Query Parameters
  • As-of date to retrieve clinical data
    Example:
    10-Dec-2025 14:30:15.123
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example:
    ABCDEF1234567890ABCDEF1234567890

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Subjects success.
Body ()
Root Schema : schema
Type: array
Show Source
  • ClinicalData1
    ODM ClinicalData section containing study OID, metadata version OID, and lists of subject data, audit records, signatures, and annotations.
Nested Schema : ClinicalData1
Type: object
ODM ClinicalData section containing study OID, metadata version OID, and lists of subject data, audit records, signatures, and annotations.
Show Source
Nested Schema : Annotations
Type: array
List of annotations attached to the clinical data
Show Source
Nested Schema : auditRecords
Type: array
List of audit records associated with clinical data
Show Source
Nested Schema : Signatures
Type: array
List of digital signatures applied to the clinical data
Show Source
Nested Schema : subjectData
Type: array
List of subject-level clinical data records
Show Source
Nested Schema : Annotations1
Type: object
Container for a list of ODM Annotation entries.
Show Source
Nested Schema : annotation
Type: array
List of Annotation entries associated to the ODM structure.
Show Source
Nested Schema : Annotation2
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : Comment2
Type: object
Comment DTO
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : FlagType1
Type: object
Flag type
Show Source
Example:
{
    "flagOID":"QUERY"
}
Nested Schema : FlagValue1
Type: object
Flag value
Show Source
Example:
{
    "value":"Review"
}
Nested Schema : AuditRecords1
Type: object
Container for a list of ODM audit record entries.
Show Source
Nested Schema : auditRecord
Type: array
List of audit records associated with the subject or form.
Show Source
Nested Schema : AuditRecord100
Type: object
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
Show Source
Nested Schema : DateTimeStamp1
Type: object
Date/time stamp value with formatted representation.
Show Source
Nested Schema : LocationRef1
Type: object
Reference to a study/site location for an ODM User.
Show Source
Nested Schema : ReasonForChange1
Type: object
Explanation provided to justify why a data value was created or modified.
Show Source
  • Free-text reason describing the change.
    Example: Correction of data entry error
Nested Schema : SourceID1
Type: object
Identifier of the originating system or source that provided the data.
Show Source
Nested Schema : UserRef10
Type: object
Reference to a user within the study.
Show Source
Nested Schema : Signatures1
Type: object
Container for a list of ODM Signature entries.
Show Source
Nested Schema : signature
Type: array
List of signature entries associated with the ODM structure.
Show Source
Nested Schema : Signature1
Type: object
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
Show Source
Nested Schema : CryptoBindingManifest10
Type: object
Cryptographic binding manifest that ties the signature to the signed payload.
Show Source
  • Base64-encoded manifest payload.
    Example: VGhpcyBpcyBhIG1hbmlmZXN0IHBheWxvYWQ=
Nested Schema : SignatureRef1
Type: object
Reference to a signature object used to approve or verify data.
Show Source
Nested Schema : SubjectData1
Type: object
ODM SubjectData structure including audit, signature, references and event data for a subject.
Show Source
Nested Schema : annotation
Type: array
List of annotations (queries, notes, flags) linked to the subject data.
Show Source
Nested Schema : InvestigatorRef1
Type: object
Reference to an investigator user participating in the study.
Show Source
  • Identifier (OID) of the investigator user within the study.
    Example: c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : SiteRef10
Type: object
Reference to a study site/location.
Show Source
Nested Schema : studyEventData
Type: array
All scheduled or unscheduled visit/event data for the subject.
Show Source
Nested Schema : subjectHistory
Type: array
Chronological history of key actions for this subject.
Show Source
  • History1
    Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Nested Schema : transferData
Type: array
Data transfer records for this subject (e.g., imports or system migrations).
Show Source
Nested Schema : StudyEventData1
Type: object
Subject visit or study event data block including forms, annotations and references.
Show Source
Nested Schema : annotation
Type: array
Annotations (queries, comments, flags) on this study event.
Show Source
Nested Schema : EventHistory
Type: array
History of actions performed on this study event.
Show Source
  • History1
    Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Example:
[
    {
        "action":"Locked",
        "actionDate":"2025-11-01T14:00:00Z"
    }
]
Nested Schema : formData
Type: array
Forms captured within this study event.
Show Source
Nested Schema : RepeatingFormSummary1
Type: object
Summary container for sets of repeating forms within a study event.
Show Source
Nested Schema : History1
Type: object
Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Show Source
Nested Schema : details
Type: array
Additional details about the action.
Show Source
  • Additional details about the action.
    Example: ["Verified by Data Manager","No discrepancies found"]
Example:
[
    "Verified by Data Manager",
    "No discrepancies found"
]
Nested Schema : FormData10
Type: object
Data captured for a single form within a study event, including items, annotations, signatures, and status.
Show Source
Nested Schema : Annotation
Type: array
Annotations (queries, notes, flags) for this form.
Show Source
Nested Schema : ArchiveLayoutRef1
Type: object
Archive layout reference
Show Source
Nested Schema : ItemGroupData
Type: array
Groups of item data contained in this form.
Show Source
Nested Schema : ItemGroupData1
Type: object
Data captured for a Item Group
Show Source
Nested Schema : annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : items
Type: object
Data captured for a Item
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : Annotation
Type: object
Note, query, or other annotation associated with a data point, including flags and a comment.
Show Source
Nested Schema : MeasurementUnitRef1
Type: object
Data captured for a Measurement Unit
Show Source
Nested Schema : flag
Type: object
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
Nested Schema : repeatingFormData
Type: array
Collection of repeating form data entries.
Show Source
Nested Schema : RepeatingFormData1
Type: object
A single repeating form instance including headers and rows of item data.
Show Source
Nested Schema : formHeader
Type: array
Header section for the repeating form instance (metadata about the form).
Show Source
Nested Schema : Row
Type: array
Rows comprising items captured in this form instance.
Show Source
  • Row2
    A single row within a repeating form instance containing associated forms and item data.
Nested Schema : FormHeader1
Type: object
Header metadata for a form instance, including basic identity and display information.
Show Source
Nested Schema : Row2
Type: object
A single row within a repeating form instance containing associated forms and item data.
Show Source
Nested Schema : associatedFormList
Type: array
List of forms associated with this row, if any.
Show Source
Nested Schema : item
Type: array
Items captured within this row.
Show Source
Nested Schema : AssociatedFormList1
Type: object
Associated form details including visit and audit metadata
Show Source
Nested Schema : auditTrail
Type: array
List of audit trail entries
Show Source
Nested Schema : AuditTrail1
Type: object
Audit trail entry with timestamp, user, deletion status and note
Show Source
Nested Schema : Item1
Type: object
ODM Item instance with value and identifiers
Show Source
  • Indicates whether this item represents an itemset (grid or repeating values).
    Example: false
  • Row identifiers or count for the itemset when itemset is true.
    Example: 1
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 3F2504E04F8911D39A0C0305E82C3301
  • 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: SAMPLE_VALUE
Nested Schema : TransferData1
Type: object
Subject transfer details between sites
Show Source
Examples

400 Response

Bad request.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top