[Deprecated]: Update single data element
put
/ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Deprecated: Updates single data element with support for the fields lockStatus and lockDateTime. Supports the features of PUT operation of v9.0 of this API along with the additional fields lockStatus and lockDateTime.
Request
Path Parameters
-
dataElementId(required): string
Data value to update.
-
mode(required): string
-
studyId(required): string
Supported Media Types
- application/json
Nested Schema : DataElementDto14
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:2048Comment for the data element changeExample:Captured by device -
dataFlag: string
(uuid)
Data flag identifier
-
dateTimeValueUTC: string
(date-time)
Date-time value in UTCExample:
2025-10-16T14:30:31.892Z -
dayValue: integer
(int32)
Day part of dateExample:
16 -
eventId: string
Event identifier in uppercase hex formatExample:
ADF5A7800A954FA5B831E7B6B9CA39A9 -
eventInstanceNum: integer
(int32)
Unscheduled/cycle visit instance number when applicable.Example:
1 -
floatValue: number
(decimal)
Numeric decimal valueExample:
12.34 -
formId: string
Form identifier in uppercase hex formatExample:
40DB4EF4847849CCB24EFCCB71CDA436 -
formSectionId: string
Form section identifier in uppercase hex formatExample:
B6E0C7D5A1F3428C8B8B6A77C5E9D4AA -
freezedStatus: string
Freeze status of the data elementExample:
FROZEN -
hdiId: string
-
hourValue: integer
(int32)
Hour part of timeExample:
14 -
id: string
(uuid)
Unique identifier of the data element
-
innerRepeat: integer
-
itemId: string
Item identifier in uppercase hex formatExample:
DEADBEEFDEADBEEFDEADBEEFDEADBEEF -
lockedDateTime: string
(date-time)
-
lockedStatus: string
-
measureUnit: string
Minimum Length:
0Maximum Length:64Measurement unitExample:mg/dL -
minuteValue: integer
(int32)
Minute part of timeExample:
30 -
monthValue: integer
(int32)
Month part of dateExample:
10 -
normalizedUnitId: string
Identifier of normalized unitExample:
A78AD8C31CD843CD8B847C06C0420FF5 -
normalizedValue: string
Minimum Length:
0Maximum Length:100Normalized value if applicableExample:A78AD8C31CD843CD8B847C06C0420FF5 -
numValue: integer
(int32)
Numeric integer valueExample:
120 -
objectVersionNumber: number
Object version number for optimistic lockingExample:
14 -
originatorId: string
Originator identifier in uppercase hex formatExample:
FEDCBA9876543210FEDCBA9876543210 -
outerRepeat: integer
-
propertyId: string
-
propertyVersionStart: string
(date-time)
-
reason: string
Minimum Length:
0Maximum Length:255Reason associated with the data element changeExample:Initial entry -
repeatFormNumber: integer
-
repeatSequenceNumber: integer
(int32)
Repeat sequence number for repeating form or itemExample:
1 -
secondValue: integer
(int32)
Second part of timeExample:
31 -
signedStatus: string
Signature status of the data elementExample:
SIGNED -
siteId: string
Site identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
studyId: string
Study identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
studyName: string
Minimum Length:
0Maximum Length:100Study nameExample:STUDY-ABC -
studyVersion(required): string
Minimum Length:
0Maximum Length:100Study version stringExample:3.0.0.1 -
subjectId: string
Subject identifier in uppercase hex formatExample:
10F75668189F422F9A461A315D211111 -
targets: array
targets
List of display or rule targets associated with this data element
-
transactionEnd: string
(date-time)
Transaction end timestampExample:
2025-10-16T14:30:31.892Z -
transactionStart: string
(date-time)
Transaction start timestampExample:
2025-10-16T14:30:31.892Z -
userId: string
(uuid)
-
validationFailure: string
Minimum Length:
0Maximum Length:32767Validation failure details if anyExample:Incorrect values not allowed -
validationStatus: string
Minimum Length:
0Maximum Length:25Validation status of the data elementExample:SUCCESS -
value: string
Minimum Length:
0Maximum Length:4000Raw value captured for the itemExample:120 -
variableId: string
Variable identifier in uppercase hex formatExample:
0123456789ABCDEF0123456789ABCDEF -
vendorCode: string
Minimum Length:
0Maximum Length:100Vendor code if providedExample:VENDOR1 -
verifiedStatus: string
Verification status of the data elementExample:
VERIFIED -
versionStart: string
(date-time)
Start timestamp of the element versionExample:
2025-10-16T14:30:31.892Z -
yearValue: integer
(int32)
Year part of dateExample:
2025
Nested Schema : targets
Type:
arrayList of display or rule targets associated with this data element
Show Source
-
Array of:
string
List of display or rule targets associated with this data elementExample:
["93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5","93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"]
Example:
[
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
]Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : DataElementDto14
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:2048Comment for the data element changeExample:Captured by device -
dataFlag: string
(uuid)
Data flag identifier
-
dateTimeValueUTC: string
(date-time)
Date-time value in UTCExample:
2025-10-16T14:30:31.892Z -
dayValue: integer
(int32)
Day part of dateExample:
16 -
eventId: string
Event identifier in uppercase hex formatExample:
ADF5A7800A954FA5B831E7B6B9CA39A9 -
eventInstanceNum: integer
(int32)
Unscheduled/cycle visit instance number when applicable.Example:
1 -
floatValue: number
(decimal)
Numeric decimal valueExample:
12.34 -
formId: string
Form identifier in uppercase hex formatExample:
40DB4EF4847849CCB24EFCCB71CDA436 -
formSectionId: string
Form section identifier in uppercase hex formatExample:
B6E0C7D5A1F3428C8B8B6A77C5E9D4AA -
freezedStatus: string
Freeze status of the data elementExample:
FROZEN -
hdiId: string
-
hourValue: integer
(int32)
Hour part of timeExample:
14 -
id: string
(uuid)
Unique identifier of the data element
-
innerRepeat: integer
-
itemId: string
Item identifier in uppercase hex formatExample:
DEADBEEFDEADBEEFDEADBEEFDEADBEEF -
lockedDateTime: string
(date-time)
-
lockedStatus: string
-
measureUnit: string
Minimum Length:
0Maximum Length:64Measurement unitExample:mg/dL -
minuteValue: integer
(int32)
Minute part of timeExample:
30 -
monthValue: integer
(int32)
Month part of dateExample:
10 -
normalizedUnitId: string
Identifier of normalized unitExample:
A78AD8C31CD843CD8B847C06C0420FF5 -
normalizedValue: string
Minimum Length:
0Maximum Length:100Normalized value if applicableExample:A78AD8C31CD843CD8B847C06C0420FF5 -
numValue: integer
(int32)
Numeric integer valueExample:
120 -
objectVersionNumber: number
Object version number for optimistic lockingExample:
14 -
originatorId: string
Originator identifier in uppercase hex formatExample:
FEDCBA9876543210FEDCBA9876543210 -
outerRepeat: integer
-
propertyId: string
-
propertyVersionStart: string
(date-time)
-
reason: string
Minimum Length:
0Maximum Length:255Reason associated with the data element changeExample:Initial entry -
repeatFormNumber: integer
-
repeatSequenceNumber: integer
(int32)
Repeat sequence number for repeating form or itemExample:
1 -
secondValue: integer
(int32)
Second part of timeExample:
31 -
signedStatus: string
Signature status of the data elementExample:
SIGNED -
siteId: string
Site identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
studyId: string
Study identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
studyName: string
Minimum Length:
0Maximum Length:100Study nameExample:STUDY-ABC -
studyVersion(required): string
Minimum Length:
0Maximum Length:100Study version stringExample:3.0.0.1 -
subjectId: string
Subject identifier in uppercase hex formatExample:
10F75668189F422F9A461A315D211111 -
targets: array
targets
List of display or rule targets associated with this data element
-
transactionEnd: string
(date-time)
Transaction end timestampExample:
2025-10-16T14:30:31.892Z -
transactionStart: string
(date-time)
Transaction start timestampExample:
2025-10-16T14:30:31.892Z -
userId: string
(uuid)
-
validationFailure: string
Minimum Length:
0Maximum Length:32767Validation failure details if anyExample:Incorrect values not allowed -
validationStatus: string
Minimum Length:
0Maximum Length:25Validation status of the data elementExample:SUCCESS -
value: string
Minimum Length:
0Maximum Length:4000Raw value captured for the itemExample:120 -
variableId: string
Variable identifier in uppercase hex formatExample:
0123456789ABCDEF0123456789ABCDEF -
vendorCode: string
Minimum Length:
0Maximum Length:100Vendor code if providedExample:VENDOR1 -
verifiedStatus: string
Verification status of the data elementExample:
VERIFIED -
versionStart: string
(date-time)
Start timestamp of the element versionExample:
2025-10-16T14:30:31.892Z -
yearValue: integer
(int32)
Year part of dateExample:
2025
Nested Schema : targets
Type:
arrayList of display or rule targets associated with this data element
Show Source
-
Array of:
string
List of display or rule targets associated with this data elementExample:
["93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5","93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"]
Example:
[
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
]400 Response
Bad request.
Root Schema : DcsResponse
Type:
Show Source
object-
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)
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
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 -
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
Nested Schema : result
Type:
object