Jump to

• Request
• Response

V1.0

get

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

Acquires the lock of a study or study object.

Request

Path Parameters

• studyId(required): string(uuid)
  Study identifier (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• lockBasePath: string
  The base lock path to retrieve the locks for.

  Example:

  /locks/studies

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ChildLockData

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

Nested Schema : ChildLockData

Type: object

Show Source

• lockPath: string
• status: boolean
• userId: string
• userName: string

{
    "type":"object",
    "properties":{
        "lockPath":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "status":{
            "type":"boolean"
        },
        "userName":{
            "type":"string"
        }
    }
}

Examples

Select an example successResponse

Back to Top