1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Study APIs
  5. Study Lock
  6. Acquire lock

V1.0

post

/ec-designer-svc/rest/locks/acquireLock/{studyId}

Acquires the lock of a study or study object.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : DesignerLockDetailsDto v1.0
Type: object
Title: DesignerLockDetailsDto v1.0
Lock details used to acquire or renew a study design lock.
Show Source
  • Indicates whether the request is for a UI lock.
    Example: true
  • Base path for the lock. If provided, this path is used before lockPathParams. Optional when lockPathParams are provided.
    Example: studies/2F9A6C7E1B8F4D56A23C9F3A0C7D4E11
  • Client-provided lock mode for the request.
    Example: active
  • Allowed Values: [ "studyDesignSettings", "studyDesign", "studyDesignForm", "studyDesignVersion" ]
    Name of the lock to acquire. Allowed values: studyDesignSettings, studyDesign, studyDesignForm, studyDesignVersion.
    Example: studyDesign
  • lockPathParams
    Additional Properties Allowed: additionalProperties
    Values used to resolve the lock path when lockBasePath is not provided. For studyId, use UUID, 32-character uppercase hexadecimal string.
  • Indicates whether this request renews an existing lock. When false, other locks held by the same user for the study are released before acquiring this lock.
    Example: false
  • Service name associated with the lock request. Designer lock requests use designer.
    Example: designer
  • User identifier supplied with the lock request. UUID, 32-character uppercase hexadecimal string.
    Example: B1B8327AFAA6412287106192AB5984EF
Example:
{
    "serviceName":"designer",
    "lockBasePath":"studies/2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "lockName":"studyDesign",
    "userId":"B1B8327AFAA6412287106192AB5984EF",
    "isUILock":true,
    "lockMode":"active",
    "lockPathParams":{
        "studyId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11"
    },
    "renewal":false
}
Nested Schema : lockPathParams
Type: object
Additional Properties Allowed
Show Source
  • Values used to resolve the lock path when lockBasePath is not provided. For studyId, use UUID, 32-character uppercase hexadecimal string.
    Example: {"studyId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11"}
Values used to resolve the lock path when lockBasePath is not provided. For studyId, use UUID, 32-character uppercase hexadecimal string.
Example:
{
    "studyId":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11"
}
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : LockTO v2.0
Type: object
Title: LockTO v2.0
Result of a study design lock acquisition request.
Show Source
  • Error code returned when the lock cannot be acquired.
    Example: C1-930
  • Indicates whether the existing lock timeout was extended.
    Example: false
  • Indicates whether the previous lock owner matches the current user.
    Example: false
  • Message returned when the lock cannot be acquired.
    Example: Lock is already owned by another user.
  • Previous lock owner user identifier, when a previous owner is available. UUID, 32-character uppercase hexadecimal string.
    Example: A1A8327AFAA6412287106192AB5984EF
  • Previous lock owner user name, when a previous owner is available.
    Example: previous.user
  • Indicates whether the requested lock was acquired.
    Example: true
  • Current lock request user identifier. UUID, 32-character uppercase hexadecimal string.
    Example: B1B8327AFAA6412287106192AB5984EF
  • Current lock request user name.
    Example: designer.user
Example:
{
    "status":true,
    "isSameUser":false,
    "prvUserId":"A1A8327AFAA6412287106192AB5984EF",
    "userId":"B1B8327AFAA6412287106192AB5984EF",
    "isLockTimeOutIncreased":false,
    "userName":"designer.user",
    "prvUserName":"previous.user"
}
Examples

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Back to Top