Lock data elements in a visit
post
/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks
This API locks the items, forms or entire visit for a given visit of a subject.
Request
Path Parameters
-
eventId(required): string(uuid)
Event ID froom Designer to fetch the records for
-
mode(required): string
Mode to fetch the records for
-
studyId(required): string
ID of the study to fetch the records for
-
subjectId(required): string(uuid)
Subject ID to fetch the records for
Supported Media Types
- */*
Response
Supported Media Types
- application/json
200 Response
Success
Nested Schema : DataActionsDTO
Type:
Show Source
object
-
action: string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
eventId: string
(uuid)
-
eventInstanceNum: integer
-
formId: string
(uuid)
-
formSectionId: string
(uuid)
-
id: string
(uuid)
-
innerRepeat: integer
-
itemId: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
-
outerRepeat: integer
-
reason: string
Minimum Length:
0
Maximum Length:255
-
repeatFormNumber: integer
-
repeatSequenceNumber: integer
-
siteId: string
(uuid)
-
softwareVersionNumber: number
-
studyVersion: string
-
subjectId: string
(uuid)
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
-
visitStartDateAction: string
400 Response
Bad_Request
Root Schema : RestResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
object
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.