Jump to

• Request
• Response

V1.0

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlockvisits

API unlocks all visit records associated with the specified subject, based on the provided subject ID. This endpoint is used to remove visit-level locks, allowing updates and data entry for all visits of the selected subject within a clinical study.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  A834DE46BBFA4737B98EFF1087A26DEA

• subjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  A8BAB123BAC4410B9AB0137E6C889821

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Unlock DTO for unlocking all visits/items for a subject, except subject-level. All fields are optional.

Show Source

• comment: string
  Additional comment or context for the unlock request.

  Example: Unlocking all visits except main subject lock due to CRA request.
• reason: string
  Reason for requesting this unlock.

  Example: Other.
• siteId: string (UUID)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: b123fe17aac4410b9ab0137e6c88981a
• userId: string (UUID)
  Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 91d1b34ed1904d8499844159776b2fd7

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"b123fe17aac4410b9ab0137e6c88981a"
        },
        "userId":{
            "type":"string",
            "description":"Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"91d1b34ed1904d8499844159776b2fd7"
        },
        "reason":{
            "type":"string",
            "description":"Reason for requesting this unlock.",
            "example":"Other."
        },
        "comment":{
            "type":"string",
            "description":"Additional comment or context for the unlock request.",
            "example":"Unlocking all visits except main subject lock due to CRA request."
        }
    },
    "description":"Unlock DTO for unlocking all visits/items for a subject, except subject-level. All fields are optional."
}

Examples

Select an example UnlockDto Example

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted - unlock starts (no response body for this API).

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top