REST API for Clinical One Platform

~~[Deprecated]: V1.0~~

delete

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements

Deprecated: Removes the data elements in a form within a given visit. This API supports tabular forms and is mainly used for both repeating forms.
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.

Request

Path Parameters

formId(required): string(uuid)

ID of the form for which you want to delete data elements.
mode(required): string
Mode of the study, accepts: test, active, or training.
Example:
```
active
```
studyId(required): string(uuid)
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
Example:
```
9FCBB303F8D24A3FB7DABCACF7600629
```
subjectId(required): string(uuid)

ID of the subject for whom you want to delete data elements.
visitId(required): string(uuid)

ID of the Visit for which you want to delete data elements.

Query Parameters

eventInstanceNum: integer

Instance of the visit for which you want to delete data elements.
repeatSequenceNumber: integer

Form Repeat Sequence Number of the form for which you want to delete data elements.

Supported Media Types

Root Schema : schema

Type: object

Reason and comment to justify operation.

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment

Example: Removing incorrect data captured by mistake
reason: string

Minimum Length: 0

Maximum Length: 255

Reason

Example: Incorrect entry

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"Incorrect entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment",
            "example":"Removing incorrect data captured by mistake"
        }
    },
    "description":"Reason and comment to justify operation."
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataElementDto

Base data element details including identity, study and subject context, values and metadata

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataElementDto"
    }
}

Nested Schema : DataElementDto

Type: object

Base data element details including identity, study and subject context, values and metadata

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment for the data element change

Example: Captured by device
dateTimeValueUTC: string (date-time)

Date-time value in UTC

Example: 2025-10-16T14:30:31.892Z
dayValue: integer (int32)

Day part of date

Example: 16
eventId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

Example: ADF5A7800A954FA5B831E7B6B9CA39A9
floatValue: number (decimal)

Numeric decimal value

Example: 12.34
formId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

Example: 40DB4EF4847849CCB24EFCCB71CDA436
formSectionId: string (UUID)

ID (UUID, 32-character uppercase hexadecimal string) of the form section.

Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
hourValue: integer (int32)

Hour part of time

Example: 14
id: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
itemId: string (UUID)

Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
measureUnit: string

Minimum Length: 0

Maximum Length: 64

Measurement unit

Example: mg/dL
minuteValue: integer (int32)

Minute part of time

Example: 30
monthValue: integer (int32)

Month part of date

Example: 10
normalizedUnitId: string

Identifier of normalized unit

Example: A78AD8C31CD843CD8B847C06C0420FF5
normalizedValue: string

Minimum Length: 0

Maximum Length: 100

Normalized value if applicable

Example: 120
numValue: integer (int32)

Numeric integer value

Example: 120
originatorId: string (UUID)

An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).

Example: FEDCBA9876543210FEDCBA9876543210
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the data element change

Example: Initial entry
repeatSequenceNumber: integer (int32)

Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

Example: 1
secondValue: integer (int32)

Second part of time

Example: 31
siteId: string (UUID)

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

Example: ABCDEF1234567890ABCDEF1234567890
studyId: string (UUID)

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Example: ABCDEF1234567890ABCDEF1234567890
studyName: string

Minimum Length: 0

Maximum Length: 100

Study name

Example: STUDY-ABC
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

String representing the version of the study configuration or protocol. Helps track changes in form or study design.

Example: 3.0.0.1
subjectId: string (UUID)

Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

Example: 10F75668189F422F9A461A315D211111
transactionEnd: string (date-time)

The date and time at which the transaction processing completed.

Example: 2025-10-16T14:30:31.892Z
transactionStart: string (date-time)

The date and time at which the transaction processing began.

Example: 2025-10-16T14:30:31.892Z
validationFailure: string

Minimum Length: 0

Maximum Length: 32767

Validation failure details if any

Example: Incorrect values not allowed
validationStatus: string

Minimum Length: 0

Maximum Length: 25

Validation status of the data element. The validation status can be null or SUCCESS.

Example: SUCCESS
value: string

Minimum Length: 0

Maximum Length: 4000

Raw value captured for the item

Example: 120
variableId: string (UUID)

Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.

Example: 0123456789ABCDEF0123456789ABCDEF
vendorCode: string

Minimum Length: 0

Maximum Length: 100

Vendor code if provided

Example: VENDOR1
versionStart: string (date-time)

The timestamp marking the beginning of the validity period for this record version within the system.

Example: 2025-10-16T14:30:31.892Z
yearValue: integer (int32)

Year part of date

Example: 2025

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionStart":{
            "type":"string",
            "description":"The date and time at which the transaction processing began.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionEnd":{
            "type":"string",
            "description":"The date and time at which the transaction processing completed.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "validationStatus":{
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"Validation status of the data element. The validation status can be null or SUCCESS.",
            "example":"SUCCESS"
        },
        "validationFailure":{
            "maxLength":32767,
            "minLength":0,
            "type":"string",
            "description":"Validation failure details if any",
            "example":"Incorrect values not allowed"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study name",
            "example":"STUDY-ABC"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"UUID",
            "example":"10F75668189F422F9A461A315D211111"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "format":"UUID",
            "example":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int32",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "variableId":{
            "type":"string",
            "description":"Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.",
            "format":"UUID",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "originatorId":{
            "type":"string",
            "description":"An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"FEDCBA9876543210FEDCBA9876543210"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Vendor code if provided",
            "example":"VENDOR1"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Raw value captured for the item",
            "example":"120"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string",
            "description":"Measurement unit",
            "example":"mg/dL"
        },
        "normalizedValue":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Normalized value if applicable",
            "example":"120"
        },
        "normalizedUnitId":{
            "type":"string",
            "description":"Identifier of normalized unit",
            "example":"A78AD8C31CD843CD8B847C06C0420FF5"
        },
        "numValue":{
            "type":"integer",
            "description":"Numeric integer value",
            "format":"int32",
            "example":120
        },
        "floatValue":{
            "type":"number",
            "description":"Numeric decimal value",
            "format":"decimal",
            "example":12.34
        },
        "dateTimeValueUTC":{
            "type":"string",
            "description":"Date-time value in UTC",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "monthValue":{
            "type":"integer",
            "description":"Month part of date",
            "format":"int32",
            "example":10
        },
        "dayValue":{
            "type":"integer",
            "description":"Day part of date",
            "format":"int32",
            "example":16
        },
        "yearValue":{
            "type":"integer",
            "description":"Year part of date",
            "format":"int32",
            "example":2025
        },
        "hourValue":{
            "type":"integer",
            "description":"Hour part of time",
            "format":"int32",
            "example":14
        },
        "minuteValue":{
            "type":"integer",
            "description":"Minute part of time",
            "format":"int32",
            "example":30
        },
        "secondValue":{
            "type":"integer",
            "description":"Second part of time",
            "format":"int32",
            "example":31
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the data element change",
            "example":"Initial entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for the data element change",
            "example":"Captured by device"
        }
    },
    "description":"Base data element details including identity, study and subject context, values and metadata"
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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: object details

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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