1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Data Capture
  4. Data Elements
  5. Clear form data

V1.0

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/clear/forms

Skeleton endpoint for clearing form data.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload for clearing form data.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment
  • Minimum Length: 0
    Maximum Length: 255
    Reason
    Example: Change for encoding
  • 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: ABCDEF1234567890ABCDEF1234567890
  • visits
    List of visit payloads for clear form operation.
Nested Schema : visits
Type: array
List of visit payloads for clear form operation.
Show Source
Nested Schema : ClearFormsVisitRequestDto
Type: object
Visit-level payload for clear form API.
Show Source
  • 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: CBCDEF1234567890ABCDEF1234567890
  • 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
  • forms
    List of forms to clear in this visit.
  • String representing the version of the study. Helps track changes in form or study design.
    Example: 1.0.0.0
Nested Schema : forms
Type: array
List of forms to clear in this visit.
Show Source
Nested Schema : ClearFormsFormRequestDto
Type: object
Form-level payload for clear form API.
Show Source
  • 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: 50DB4EF4847849CCB24EFCCB71CDA436
  • 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
  • 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
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : ClearFormsResponseDto10
Type: object
Response payload for clear form API.
Show Source
Nested Schema : ClearFormsClearedDataDto10
Type: object
Cleared data section for clear form response.
Show Source
Nested Schema : formsStatus
Type: array
Form status summary after clear action.
Show Source
Nested Schema : notClearedData
Type: array
Data elements that could not be cleared.
Show Source
Nested Schema : Visits
Type: object
Visit status targets and refresh indicator.
Show Source
Nested Schema : dataElements
Type: array
Cleared data elements.
Show Source
Nested Schema : labs
Type: array
Cleared lab associations.
Show Source
Nested Schema : DataElementDto136
Type: object
Data element DTO version 136
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 of the associated source document (hex UUID, 32-character uppercase), enabling traceability between the data element and its original supporting document or file.
    Example: A1B2C3D4E5F64789ABCDEF0123456789
  • Version of the source or supporting document linked to this data element.
    Example: 1
  • 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
  • Timestamp when the data element lock state last changed
    Example: 2023-01-01T09:00:00Z
  • Lock state of the data element. Values LOCKED, UNLOCKED, NEVER_LOCKED
    Example: LOCKED
  • 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
  • Timestamp when the data element was captured in the source system
    Example: 2025-10-16T14:30:31.892Z
  • 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
  • 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
  • Timestamp when the visit start date lock state last changed
    Example: 2023-01-01T09:00:00Z
  • Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.
    Example: NEVER_LOCKED
  • Year part of date
    Example: 2025
Nested Schema : DCPropertyDto
Type: object
Laboratory property details associated with a data element.
Show Source
  • Comment
    Example: Cleared due to verified lab correction
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • 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
  • Reason
    Example: Data cleared by monitor
Nested Schema : FormsStatusResponseDto
Type: object
Form status with outer repeat hierarchy.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • 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: IN_PROGRESS
  • outerRepeats
    Outer repeat entries for this form
Nested Schema : outerRepeats
Type: array
Outer repeat entries for this form
Show Source
Nested Schema : FormsStatusOuterRepeatDto
Type: object
Outer repeat status with inner repeat entries.
Show Source
  • 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: IN_PROGRESS
  • innerRepeats
    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.
  • 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
Nested Schema : innerRepeats
Type: array
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.
Show Source
Nested Schema : FormsStatusInnerRepeatDto
Type: object
Inner repeat status for a specific outer repeat.
Show Source
  • 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: IN_PROGRESS
  • 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
  • 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
Nested Schema : ClearFormsNotClearedDataDto10
Type: object
Represents an item that could not be cleared in clear form API.
Show Source
Nested Schema : VisitsStatusRuleTargetsDto7
Type: object
Visit status update response including visit action and inherited rule targets
Show Source
  • String representing the version of the study. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 2048
    Additional comment for the visit status
    Example: All data verified
  • 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: ABCDEF1234567890ABCDEF1234567890
  • 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
  • Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.
    Example: Visit_Not_Started
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the visit status
    Example: Subject completed the visit successfully
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • 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: ABCDEF1234567890ABCDEF1234567890
  • targets
    List of rule targets affected by this operation
  • Start timestamp of the version record
    Example: 2025-10-16T14:30:31.892Z
  • Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.
    Example: SCREEN_ENABLE
  • Visit start date timestamp
    Example: 2025-10-16T14:30:31.892Z
  • Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.
    Example: COMPLETE
  • Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.
    Example: SCREENING
Nested Schema : targets
Type: array
List of rule targets affected by this operation
Show Source
  • List of rule targets affected by this operation
    Example: ["DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"]
Example:
[
    "DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"
]

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Back to Top