Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/lock

Get a lock for a study.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LockDto v1.0

Type: object

Title: LockDto v1.0

Study lock details.

Show Source

• expiry: string (date-time)
  Expiry
• lockUser: string (uuid)
  Lock user GUID
• lockUsername: string
  Lock user name.

  Example: username

{
    "title":"LockDto v1.0",
    "type":"object",
    "properties":{
        "lockUser":{
            "type":"string",
            "description":"Lock user GUID",
            "format":"uuid"
        },
        "lockUsername":{
            "type":"string",
            "description":"Lock user name.",
            "example":"username"
        },
        "expiry":{
            "type":"string",
            "description":"Expiry",
            "format":"date-time"
        }
    },
    "description":"Study lock details."
}

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