Get locked objects
post
/ec-designer-svc/rest/v2.0/studies/{studyId}/lockObjectDetails
Retrieves a list of locked objects as on locked date.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
items: string
-
itemsIncluded: boolean
-
mode(required): string
Study mode to filter locked objects.Allowed Values:
[ "test", "training", "active" ]
-
showParent: string
-
showVisitDetails: boolean
Supported Media Types
- */*
Nested Schema : LockObjectDtoV2
Type:
Show Source
object
-
objectId(required): string
(uuid)
Object ID
-
objectLockDate: string
(date-time)
Object Lock Date
-
objectLockVersion(required): string
Title:
ObjectLockVersion
Object lock versionExample:1.0.0.1
-
objectType(required): string
Title:
ObjectType
Allowed Values:[ "form", "visit" ]
Object typeExample:form
-
parentObjectId: string
(uuid)
Parent Object ID
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : LockObjectDetailsDto v2.0
Type:
object
Title:
LockObjectDetailsDto v2.0
Information about all the locked objects.
Show Source
-
visitObjects: object
visitObjects
Additional Properties Allowed: additionalPropertiesLocked visit object details.
Nested Schema : visitObjects
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: LockObjectVersionDetailsDtoV2Locked visit object details.
Locked visit object details.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object LockObjectVersionDetailsDtoV2
Title:
LockObjectVersionDetailsDtoV2
Information about all the locked objects in a version
Locked visit object details.
Nested Schema : LockObjectVersionDetailsDtoV2
Type:
object
Title:
LockObjectVersionDetailsDtoV2
Information about all the locked objects in a version
Show Source
-
visitDetails: object
VisitDto v9.0
Title:
VisitDto v9.0
Visit design.
Nested Schema : VisitDto v9.0
Type:
object
Title:
VisitDto v9.0
Visit design.
Show Source
-
branchId: string
(uuid)
Branch Id
-
branchTitle: string
Visit Branch titleExample:
Branch 2
-
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Visit event typeExample:
ScreeningVisit
-
fullName: string
Concatenation of Visit Title and Branch title with hypenExample:
B1C01 - V01
-
id: string
(uuid)
Visit GUID
-
lastRequired: boolean
Yes - if Visit is last required.Example:
false
-
randomization: string
(uuid)
Randomization GUID
-
repeatNumber(required): integer
(int32)
Times to repeat Visit Design.Example:
5
-
repeatVisit(required): boolean
Yes - if Visit Design is repeating.Example:
false
-
requiredVisit(required): boolean
Yes - if Visit Design is required.Example:
false
-
shortName(required): string
Minimum Length:
1
Maximum Length:16
Pattern:[a-zA-Z0-9]+
Visit short nameExample:Week1
-
startVisitId: string
(uuid)
Start visit ID
-
studyVersion: string
Study versionExample:
1.0.0.1
-
studyVersionStatus: string
Study version statusExample:
TESTING
-
timeLine: integer
(int32)
show in timeline. allows the designer to set when a visit can be shown to a user.Example:
1
-
title(required): string
Minimum Length:
1
Maximum Length:64
Visit titleExample:Week 2
-
visitDescription: string
Visit descriptionExample:
Regular 2 week visit
-
visitStartDate: string
(date-time)
Visit start date timeExample:
2019-01-25T07:42:00.204Z
500 Response
Error
Nested Schema : details
Type:
object