Jump to

• Request
• Response

Acquire lock

post

/ec-designer-svc/rest/locks/acquireLock/{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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• isUILock: boolean
• lockBasePath: string
• lockMode: string
• lockName: string
• lockPathParams: object lockPathParams
  Additional Properties Allowed: additionalProperties
• renewal: boolean
• serviceName: string
• userId: string

{
    "type":"object",
    "properties":{
        "lockPathParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "renewal":{
            "type":"boolean"
        },
        "serviceName":{
            "type":"string"
        },
        "lockBasePath":{
            "type":"string"
        },
        "lockName":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "isUILock":{
            "type":"boolean"
        },
        "lockMode":{
            "type":"string"
        }
    }
}

Nested Schema : lockPathParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ResponseTo

Type: object

Show Source

• code: string
• message: string
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Examples

Select an example successResponse

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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top