REST API for Clinical One Cloud Service

~~[Deprecated]: V3.0~~

post

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/freeze

Deprecated: Freezes multiple data elements for a subject based on the data element ID. API has been deprecated and moved to DAS (Data Action Service) Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze.
Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study.

Supported Media Types

Root Schema : schema

Type: object

Request for bulk unsign or unverify operations for a specific event/subject.

Show Source

comment: string

Any extra comment for the action when Other is selected in reason.

Example: The data required is missing.
elements: array elements

List of core sign/verify target elements.
eventId: string (UUID)

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: 7978B7DD0A0A4CA899C485990994300C
eventInstanceNum: integer (int32)

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: 3
reason: string

Reason for the operation, if supplied. Accepted values are Change for encoding, Incorrect Subject, Investigator Correction, Transcription Error, Other.

Example: Other
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

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

Example: 2.0.0.38
subjectId: string (UUID)

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: AF77C6450BE94DE293C9630142E0AFAD

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "eventId":{
            "type":"string",
            "description":"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.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":3
        },
        "reason":{
            "type":"string",
            "description":"Reason for the operation, if supplied. Accepted values are Change for encoding, Incorrect Subject, Investigator Correction, Transcription Error, Other.",
            "example":"Other"
        },
        "comment":{
            "type":"string",
            "description":"Any extra comment for the action when Other is selected in reason.",
            "example":"The data required is missing."
        },
        "elements":{
            "type":"array",
            "description":"List of core sign/verify target elements.",
            "items":{
                "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
            }
        }
    },
    "description":"Request for bulk unsign or unverify operations for a specific event/subject.",
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : elements

Type: array

List of core sign/verify target elements.

Show Source

Array of: object CoreSignVerifyRequestDto

DTO for a single data element to be signed/unverified as part of a bulk request.

{
    "type":"array",
    "description":"List of core sign/verify target elements.",
    "items":{
        "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
    }
}

Nested Schema : CoreSignVerifyRequestDto

Type: object

DTO for a single data element to be signed/unverified as part of a bulk request.

Show Source

eventInstanceNum: integer (int32)

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: 3
formId: string (UUID)

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

Example: 7978B7DD0A0A4CA899C485990994300C
formSectionId: string (UUID)

Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
innerRepeat: integer (int64)

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
itemId: string (UUID)

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: 7978B7DD0A0A4CA899C485990994300C
outerRepeat: integer (int64)

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
repeatFormNumber: integer (int64)

Form repeat number if applicable.

Example: 0
repeatSequenceNumber: integer (int64)

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

Example: 1

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "formSectionId":{
            "type":"string",
            "description":"Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"33CAF3CB1DF64DF5A353A337CBE6B50A"
        },
        "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":"int64",
            "example":1
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Form repeat number if applicable.",
            "format":"int64",
            "example":0
        },
        "innerRepeat":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "example":1
        },
        "outerRepeat":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "example":1
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":3
        },
        "itemId":{
            "type":"string",
            "description":"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.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        }
    },
    "description":"DTO for a single data element to be signed/unverified as part of a bulk request."
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataElementDto30

Data element properties including event instance number extension

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

Nested Schema : DataElementDto30

Type: object

Data element properties including event instance number extension

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) 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
eventInstanceNum: integer (int32)

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
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)

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
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 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
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
objectVersionNumber: number

Audit trail field that represents the version number of the data.

Example: 14
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 of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ABCDEF1234567890ABCDEF1234567890
studyId: string (UUID)

Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

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. Helps track changes in form or study design.

Example: 3.0.0.1
subjectId: string (UUID)

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
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 of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "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. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"10F75668189F422F9A461A315D211111"
        },
        "eventId":{
            "type":"string",
            "description":"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.",
            "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":"Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "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 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.",
            "format":"UUID",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "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"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":14
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Data element properties including event instance number extension"
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object