1. REST API for Clinical One Platform
  2. Tasks
  3. Data Actions
  4. Sign Verify Resource
  5. Check if scope type (ITEM-VSD) item is eligible for clearing its data

V2.0

post

/ec-dataaction-svc/rest/v2.0/studies/{studyId}/{mode}/cleardatacheck/{scope}

Checks if the scope type (ITEM/VSD) item is eligible for clearing its data or not, if eligible returns the item data element object data. V2 adds more context (`value` and `scope`) than the V1 request which only includes basic structure.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
DTO for checking eligibility to clear data for a set of data elements.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ABCDEF12ABCDEF12ABCDEF12ABCDEF12
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 3
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: F1C29B36F5D64B1B95F4BDBBCEA41234
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: A1C29B36F5D64B1B95F4BDBBCEA4FF11
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: C1C29B36F5D64B1B95F4BDBBCEA48EEE
  • Repeat section form number, if applicable.
    Example: 1
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 3
  • scope type can ITEM/VSD
    Example: ITEM
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 2.0.0.38
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • value
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    A list of values to check for eligibility to clear.
Example:
{
  "studyVersion": "2.0.0.38",
  "subjectId": "1BC29B36F5D64B1B95F4BDBBCEA481BE",
  "eventId": "ABCDEF12ABCDEF12ABCDEF12ABCDEF12",
  "eventInstanceNum": 2,
  "formId": "F1C29B36F5D64B1B95F4BDBBCEA41234",
  "formSectionId": "A1C29B36F5D64B1B95F4BDBBCEA4FF11",
  "repeatSectionFormNumber": 1,
  "repeatSequenceNumber": 3,
  "itemId": "C1C29B36F5D64B1B95F4BDBBCEA48EEE",
  "value": "[ "PASS", "MISSING" ]",
  "scope": "ITEM"
}
Nested Schema : value
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
A list of values to check for eligibility to clear.
Show Source
  • A list of values to check for eligibility to clear.
    Example: ["PASS","MISSING"]
Example:
[
    "PASS",
    "MISSING"
]
Back to Top

Response

Supported Media Types

200 Response

Eligibility determination response.Update when ClearDataCheckResponse is available to include all fields.
Body ()
Root Schema : ClearDataCheckResponse
Type: object
Response to clear data eligibility check request, containing eligibility status and detailed item/child/descendant info.
Show Source
Nested Schema : childForms
Type: array
List of info for each child form object.
Show Source
Nested Schema : childQuestions
Type: array
List of info for any child question items.
Show Source
Nested Schema : childSections
Type: array
List of info for child sections (if any).
Show Source
Nested Schema : childVisits
Type: array
List of info for each child visit object.
Show Source
Nested Schema : ItemInfo
Type: object
List of info for any child question items.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
  • Name of the form.
    Example: Physical Exam
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
  • Name of the child item or question.
    Example: Is patient fasting?
  • Type of the child object: VISIT, FORM, SECTION, or QUESTION.
    Example: VISIT
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